ntopng/include/LocalHost.h
2026-03-15 10:50:50 +01:00

272 lines
10 KiB
C++

/*
*
* (C) 2013-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 _LOCAL_HOST_H_
#define _LOCAL_HOST_H_
#include "ntop_includes.h"
class LocalHost : public Host {
protected:
int32_t local_network_id;
time_t initialization_time;
bool inconsistent_host_os;
LocalHostStats* initial_ts_point;
/* contacted_server_ports it's a buffer used by the "Server Port Detected"
* check */
SPSCQueue<std::pair<u_int16_t, u_int16_t>> contacted_server_ports;
UsedPorts* usedPorts; /* List of server+client-contacted ports */
ndpi_os tcp_fingerprint_host_os; /* Learnt from TCP Fingerprinting */
HostFingerprints* fingerprints; /* Application fingerprints */
std::unordered_map<u_int32_t, DoHDoTStats*> doh_dot_map;
u_int8_t router_mac[6]; /* MAC address pf the first router used (no Mac* to
avoid purging race conditions) */
u_int8_t router_mac_set : 1, drop_all_host_traffic : 1, systemHost : 1,
asset_map_updated : 1, _notused : 4;
/* LocalHost data: update LocalHost::deleteHostData when adding new fields */
char *os_detail, *tcp_fingerprint;
std::map<OSLearningMode, ndpi_os>
os_learning; /* How OS info has been learnt */
std::map<std::string, std::string>
asset_map; /* For generic purposes, a <string, string> pair is done */
struct timeval last_periodic_asset_update;
/* END Host data: */
void initialize();
void deferredInitialization();
void freeLocalHostData();
virtual void deleteHostData();
char* getMacBasedSerializationKey(char* redis_key, size_t size, char* mac_key,
bool short_format);
char* getIPBasedSerializationKey(char* redis_key, size_t size,
bool short_format);
void luaDoHDot(lua_State* vm);
void syncMACMetadata(bool force_update);
public:
LocalHost(NetworkInterface* _iface, int32_t _iface_idx, Mac* _mac,
u_int16_t _u_int16_t, u_int16_t _observation_point_id,
IpAddress* _ip);
LocalHost(NetworkInterface* _iface, int32_t _iface_idx, char* ipAddress,
u_int16_t _u_int16_t, u_int16_t _observation_point_id);
virtual ~LocalHost();
virtual void set_hash_entry_state_idle();
virtual int32_t get_local_network_id() const { return (local_network_id); };
virtual bool isLocalHost() const { return (true); };
virtual bool isLocalUnicastHost() const {
return (!(isBroadcastHost() || isMulticastHost()));
};
virtual bool isSystemHost() const { return (systemHost); };
virtual bool serializeByMac() const {
return (iface->serializeLbdHostsAsMacs() || is_dhcp_host);
}
virtual void updateNetworkRTT(u_int32_t rtt_msecs) {
NetworkStats* network = iface->getNetworkStats(get_local_network_id());
if (network) network->updateRoundTripTime(rtt_msecs);
}
virtual NetworkStats* getNetworkStats(int32_t networkId) {
return (iface->getNetworkStats(networkId));
};
virtual u_int32_t getActiveHTTPHosts() {
return (getHTTPstats() ? getHTTPstats()->get_num_virtual_hosts() : 0);
};
virtual HostStats* allocateStats() { return (new LocalHostStats(this)); };
virtual void incResetFlow() const { stats->incResetFlow(); };
virtual bool dropAllTraffic() const { return (drop_all_host_traffic); };
virtual void inlineSetOSDetail(const char* _os_detail);
virtual const char* getOSDetail(char* const buf, ssize_t buf_len);
virtual void updateHostTrafficPolicy(char* key);
virtual void luaHTTP(lua_State* vm) { stats->luaHTTP(vm); };
virtual void luaDNS(lua_State* vm, bool verbose) {
stats->luaDNS(vm, verbose);
luaDoHDot(vm);
};
virtual void luaICMP(lua_State* vm, bool isV4, bool verbose) {
stats->luaICMP(vm, isV4, verbose);
};
virtual void lua_get_timeseries(lua_State* vm);
virtual void lua_peers_stats(lua_State* vm) const;
virtual void lua_contacts_stats(lua_State* vm) const;
virtual void incrVisitedWebSite(char* hostname) {
stats->incrVisitedWebSite(hostname);
};
virtual HTTPstats* getHTTPstats() { return (stats->getHTTPstats()); };
virtual DnsStats* getDNSstats() { return (stats->getDNSstats()); };
virtual ICMPstats* getICMPstats() { return (stats->getICMPstats()); };
virtual void luaTCP(lua_State* vm) { stats->lua(vm, false, details_normal); };
virtual u_int16_t getNumActiveContactsAsClient() {
return stats->getNumActiveContactsAsClient();
};
virtual u_int16_t getNumActiveContactsAsServer() {
return stats->getNumActiveContactsAsServer();
};
virtual void reloadPrefs();
virtual void addContactedDomainName(char* domain_name) {
stats->addContactedDomainName(domain_name);
}
virtual u_int32_t getDomainNamesCardinality() {
return stats->getDomainNamesCardinality();
}
virtual void resetDomainNamesCardinality() {
stats->resetDomainNamesCardinality();
}
virtual void serialize(json_object* obj, DetailsLevel details_level) {
return Host::serialize(obj, details_level);
};
virtual char* getSerializationKey(char* buf, u_int bufsize,
bool short_format = false);
char* getRedisKey(char* buf, uint buf_len, bool skip_prefix = false);
virtual void lua(lua_State* vm, AddressTree* ptree, bool host_details,
bool verbose, bool veryBasicInfo, bool returnHost,
bool asListElement);
void custom_periodic_stats_update(const struct timeval* tv,
bool force_update) {
;
}
virtual void luaHostBehaviour(lua_State* vm) {
if (stats) stats->luaHostBehaviour(vm);
}
virtual void incDohDoTUses(Host* srv_host);
virtual inline void incCountriesContacts(char* country) {
stats->incCountriesContacts(country);
}
virtual inline void resetCountriesContacts() {
stats->resetCountriesContacts();
}
virtual inline u_int8_t getCountriesContactsCardinality() {
return (stats->getCountriesContactsCardinality());
}
virtual inline bool incNTPContactCardinality(Host* h) {
return (stats->incNTPContactCardinality(h));
}
virtual inline bool incDNSContactCardinality(Host* h) {
return (stats->incDNSContactCardinality(h));
}
virtual inline bool incSMTPContactCardinality(Host* h) {
return (stats->incSMTPContactCardinality(h));
}
virtual inline bool incIMAPContactCardinality(Host* h) {
return (stats->incIMAPContactCardinality(h));
}
virtual inline bool incPOPContactCardinality(Host* h) {
return (stats->incPOPContactCardinality(h));
}
virtual inline u_int32_t getNTPContactCardinality() {
return (stats->getNTPContactCardinality());
}
virtual inline u_int32_t getDNSContactCardinality() {
return (stats->getDNSContactCardinality());
}
virtual inline u_int32_t getSMTPContactCardinality() {
return (stats->getSMTPContactCardinality());
}
virtual inline u_int32_t getIMAPContactCardinality() {
return (stats->getIMAPContactCardinality());
}
virtual inline u_int32_t getPOPContactCardinality() {
return (stats->getPOPContactCardinality());
}
void setRouterMac(Mac* gw);
void setServerPort(bool isTCP, u_int16_t port, ndpi_protocol* proto,
time_t when);
inline void setContactedPort(bool isTCP, u_int16_t port,
ndpi_protocol* proto) {
if (usedPorts) usedPorts->setContactedPort(isTCP, port, proto);
};
virtual inline void luaUsedPorts(lua_State* vm) {
if (usedPorts) usedPorts->lua(vm, iface);
};
virtual inline std::unordered_map<u_int16_t, ndpi_protocol>*
getUDPServerPorts() {
return (usedPorts ? usedPorts->getUDPServerPorts() : NULL);
};
virtual inline std::unordered_map<u_int16_t, ndpi_protocol>*
getTCPServerPorts() {
return (usedPorts ? usedPorts->getTCPServerPorts() : NULL);
};
virtual inline std::unordered_map<u_int16_t, ndpi_protocol>* getServerPorts(
bool isTCP) {
return (usedPorts ? usedPorts->getServerPorts(isTCP) : NULL);
};
void periodic_stats_update(const struct timeval* tv, bool force_update);
void checkGatewayInfo();
inline Fingerprint* getJA4Fingerprint() {
return (fingerprints ? &fingerprints->ja4 : NULL);
}
inline Fingerprint* getHASSHFingerprint() {
return (fingerprints ? &fingerprints->hassh : NULL);
}
void lua_get_fingerprints(lua_State* vm);
SPSCQueue<std::pair<u_int16_t, u_int16_t>>* getContactedServerPorts() {
return (&contacted_server_ports);
};
void setService(int service_enum);
void offlineSetMDNSInfo(char* const s);
void offlineSetMDNSName(const char* n);
void offlineSetDHCPName(const char* n);
void offlineSetDhcpFingerprint(const char* fingerprint);
void offlineSetMDNSTXTName(const char* n);
void offlineSetNetbiosName(const char* n);
void offlineSetTLSName(const char* n);
void offlineSetHTTPName(const char* n);
void setServerName(const char* n);
void setResolvedName(const char* resolved_name);
virtual bool setOS(ndpi_os _os, OSLearningMode mode);
void setTCPfingerprint(char* tcp_fingerprint, ndpi_os os);
virtual inline void setAssetUpdated() { asset_map_updated = 1; }
void setMACmeaningful();
inline bool isAssetUpdated() {
return (asset_map_updated || (mac && mac->isAssetUpdated()));
}
#ifdef NTOPNG_PRO
void loadAssetInfo();
void dumpAssetInfo();
bool addDataToAssets(char* field, char* value);
bool removeDataFromAssets(char* field);
void dumpAssetJson(ndpi_serializer* serializer);
void dumpAssetPortsJson(ndpi_serializer* serializer);
#endif
void setDeviceType(DeviceType devtype);
};
#endif /* _LOCAL_HOST_H_ */