vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-05-02 17:00:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
ntopng/include/Ntop.h
Luca Deri fcd8b0bedc Implements #3517
2020-03-08 11:55:41 +01:00

498 lines
19 KiB
C++
Raw Blame History

/*
*
* (C) 2013-20 - 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 _NTOP_CLASS_H_
#define _NTOP_CLASS_H_
#include "ntop_includes.h"
/** @defgroup Ntop Ntop
* Main ntopng group.
*/
class NtopPro;
/** @class Ntop
* @brief Main class of ntopng.
*
* @ingroup Ntop
*
*/
class Ntop {
private:
#ifndef WIN32
int startupLockFile;
#endif
bool ndpiReloadInProgress;
Bloom *resolvedHostsBloom; /* Used by all redis class instances */
AddressTree local_interface_addresses;
char epoch_buf[11];
char working_dir[MAX_PATH]; /**< Working directory. */
char install_dir[MAX_PATH]; /**< Install directory. */
char startup_dir[MAX_PATH]; /**< Startup directory. */
char *custom_ndpi_protos; /**< Pointer of a custom protocol for nDPI. */
NetworkInterface **iface; /**< Array of network interfaces. */
NetworkInterface *system_interface; /** The system interface */
u_int8_t num_defined_interfaces; /**< Number of defined interfaces. */
u_int8_t num_dump_interfaces;
HTTPserver *httpd; /**< Pointer of httpd server. */
NtopGlobals *globals; /**< Pointer of Ntop globals info and variables. */
u_int num_cpus; /**< Number of physical CPU cores. */
Redis *redis; /**< Pointer to the Redis server. */
Mutex m;
struct ndpi_detection_module_struct *ndpi_struct, *ndpi_struct_shadow;
#ifndef HAVE_NEDGE
ElasticSearch *elastic_search; /**< Pointer of Elastic Search. */
Logstash *logstash; /**< Pointer of Logstash. */
ExportInterface *export_interface;
#endif
TimelineExtract *extract;
PeriodicActivities *pa; /**< Instance of periodical activities. */
AddressResolution *address;
Prefs *prefs;
Geolocation *geo;
MacManufacturers *mac_manufacturers;
void *trackers_automa;
long time_offset;
time_t start_time; /**< Time when start() was called */
time_t last_stats_reset, last_ndpi_reload;
bool ndpi_cleanup_needed;
int udp_socket;
NtopPro *pro;
DeviceProtocolBitmask deviceProtocolPresets[device_max_type];
cpu_load_stats cpu_stats;
float cpu_load;
bool is_started;
std::set<std::string> *new_malicious_ja3, *malicious_ja3, *malicious_ja3_shadow;
FifoStringsQueue *sqlite_alerts_queue, *alerts_notifications_queue;
FifoSerializerQueue *internal_alerts_queue;
#ifdef __linux__
int inotify_fd;
#endif
#ifdef NTOPNG_PRO
#ifndef WIN32
NagiosManager *nagios_manager;
#endif
#endif
void loadLocalInterfaceAddress();
void initAllowedProtocolPresets();
void loadProtocolsAssociations(struct ndpi_detection_module_struct *ndpi_str);
bool checkUserPassword(const char * const user, const char * const password, char *group, bool *localuser) const;
void cleanShadownDPI();
public:
/**
* @brief A Constructor
* @details Creating a new Ntop.
*
* @param appName Describe the application name.
* @return A new instance of Ntop.
*/
Ntop(char *appName);
/**
* @brief A Destructor.
*
*/
~Ntop();
/**
* @brief Register the ntopng preferences.
* @details Setting the ntopng preferences defined in a Prefs instance.
*
* @param _prefs Prefs instance containing the ntopng preferences.
* @param quick_registration Set it to true to do a limited initialization
*/
void registerPrefs(Prefs *_prefs, bool quick_registration);
/**
* @brief Register an ntopng log file
* @details Log file is used under windows and in daemon mode
*
* @param logFile A valid path to a log file
*/
inline void registerLogFile(const char* logFile) { getTrace()->set_log_file(logFile); };
inline void rotateLogs(bool mode) { getTrace()->rotate_logs(mode); };
#ifdef NTOPNG_PRO
void registerNagios(void);
#endif
/**
* @brief Set the path of custom nDPI protocols file.
* @details Set the path of protos.txt containing the defined custom protocols. For more information please read the nDPI quick start (cd ntopng source code directory/nDPI/doc/).
*
* @param path Path of protos.file.
*/
void setCustomnDPIProtos(char *path);
/**
* @brief Get the custom nDPI protocols.
* @details Inline function.
*
* @return The path of custom nDPI protocols file.
*/
inline char* getCustomnDPIProtos() { return(custom_ndpi_protos); };
/**
* @brief Get the offset time.
* @details ....
*
* @return The timezone offset.
*/
inline long get_time_offset() { return(time_offset); };
/**
* @brief Initialize the Timezone.
* @details Use the localtime function to initialize the variable @ref time_offset.
*
*/
void initTimezone();
/**
* @brief Get a valid path.
* @details Processes the input path and return a valid path.
*
* @param path String path to validate.
* @return A valid path.
*/
char* getValidPath(char *path);
/**
* @brief Load the @ref Geolocation module.
* @details Initialize the variable @ref geo with the input directory.
*/
void loadGeolocation();
/**
* @brief Load the @ref MacManufacturers module.
* @details Initialize the variable @ref dir with the input directory.
*
* @param dir Path to database home directory.
*/
void loadMacManufacturers(char *dir);
inline void getMacManufacturer(const char *mac, lua_State *vm) {
u_int8_t mac_bytes[6];
Utils::parseMac(mac_bytes, mac);
if(mac_manufacturers)
mac_manufacturers->getMacManufacturer(mac_bytes, vm);
else
lua_pushnil(vm);
}
/**
* @brief Set the local networks.
* @details Set the local networks to @ref AddressResolution instance.
*
* @param nets String that defined the local network with this Format: 131.114.21.0/24,10.0.0.0/255.0.0.0 .
*/
void setLocalNetworks(char *nets);
/**
* @brief Check if the ingress parameter is in the local networks.
* @details Inline method.
*
* @param family Internetwork: UDP, TCP, etc.
* @param addr Internet Address.
* @param network_id It returns the networkId to which the host belongs to
* @param network_mask_bits It returns the number of bits of the network mask
* @return True if the address is in the local networks, false otherwise.
*/
bool isLocalAddress(int family, void *addr, int16_t *network_id, u_int8_t *network_mask_bits = NULL);
/**
* @brief Start ntopng packet processing.
*/
void start();
/**
* @brief Resolve the host name.
* @details Use the redis database to resolve the IP address and get the host name.
*
* @param numeric_ip Address IP.
* @param symbolic Symbolic name.
* @param symbolic_len Length of symbolic name.
*/
inline void resolveHostName(char *numeric_ip, char *symbolic, u_int symbolic_len) {
address->resolveHostName(numeric_ip, symbolic, symbolic_len);
}
inline bool resolveHost(char *host, char *rsp, u_int rsp_len, bool v4) {
return address->resolveHost(host, rsp, rsp_len, v4);
}
/**
* @brief Get the geolocation instance.
*
* @return Current geolocation instance.
*/
inline Geolocation* getGeolocation() { return(geo); };
/**
* @brief Get the mac manufacturers instance.
*
* @return Current mac manufacturers instance.
*/
inline MacManufacturers* getMacManufacturers() { return(mac_manufacturers); };
/**
* @brief Get the ifName.
* @details Find the ifName by id parameter.
*
* @param id Index of ifName.
* @return ....
*/
inline char* get_if_name(int id) { return(prefs->get_if_name(id)); };
inline const char* get_if_descr(int id) { return(prefs->get_if_descr(id)); };
inline char* get_data_dir() { return(prefs->get_data_dir()); };
inline const char* get_callbacks_dir() { return(prefs->get_callbacks_dir()); };
/**
* @brief Get the current httpdocs directory.
*
* @return The absolute path of the httpdocs directory.
*/
inline const char* get_docs_dir() { return(prefs->get_docs_dir()); };
/**
* @brief Register the network interface.
* @details Check for duplicated interface and add the network interface in to @ref iface.
*
* @param i Network interface.
* @return true on success, false otherwise
*/
bool registerInterface(NetworkInterface *i);
/**
* @brief Finalize the network interface initialization.
*
* @param i Network interface.
*/
void initInterface(NetworkInterface *i);
/**
* @brief Get the number of defined network interfaces.
*
* @return Number of defined network interfaces.
*/
inline u_int8_t get_num_interfaces() { return(num_defined_interfaces); }
/**
* @brief Get the Id of network interface.
* @details This method accepts both interface names or Ids.
*
* @param name Name of network interface.
* @return The network interface Id if exists, -1 otherwise.
*/
int getInterfaceIdByName(lua_State *vm, const char * const name);
/**
* @brief Get the network interface with the specified Id
*
* @param if_id Id of network interface.
* @return Pointer to the network interface, NULL otherwise.
*/
NetworkInterface* getInterfaceById(int if_id);
/**
* @brief Register the HTTP server.
*
* @param h HTTP server instance.
*/
inline void registerHTTPserver(HTTPserver *h) { httpd = h; };
/**
* @brief Get the network interface identified by name or Id.
* @details This method accepts both interface names or Ids.
* This method shall be called from Lua-mapped methods
* especially where constraints on user allowed interfaces
* must be enforced.
* @param name Names or Id of network interface.
* @return The network interface instance if exists, NULL otherwise.
*/
NetworkInterface* getNetworkInterface(const char *name, lua_State *vm = NULL);
inline NetworkInterface* getNetworkInterface(lua_State *vm, int ifid) {
char ifname[MAX_INTERFACE_NAME_LEN];
snprintf(ifname, sizeof(ifname), "%d", ifid);
return getNetworkInterface(ifname, vm /* enforce the check on the allowed interface */);
};
/**
* @brief Get the current HTTPserver instance.
*
* @return The current instance of HTTP server.
*/
inline HTTPserver* get_HTTPserver() { return(httpd); };
/**
* @brief Get the current working directory.
*
* @return The absolute path of working directory.
*/
inline char* get_working_dir() { return(working_dir); };
/**
* @brief Get the installation path of ntopng.
*
* @return The path of installed directory.
*/
inline char* get_install_dir() { return(install_dir); };
inline void set_install_dir(char *id) { snprintf(install_dir, MAX_PATH, "%s", id); };
/**
* @brief Get the runtime directory, which contains executable lua scripts generated at runtime.
* @note Currently an alias for the working directory
*
* @return The path of runtime directory.
*/
inline char* get_runtime_dir() { return(working_dir); };
inline Bloom* getResolutionBloom() { return(resolvedHostsBloom); };
inline NtopGlobals* getGlobals() { return(globals); };
inline Trace* getTrace() { return(globals->getTrace()); };
inline Redis* getRedis() { return(redis); };
inline TimelineExtract* getTimelineExtract() { return(extract); };
#ifndef HAVE_NEDGE
inline ExportInterface* get_export_interface() { return(export_interface); };
#endif
inline Prefs* getPrefs() { return(prefs); };
#ifndef WIN32
void lockNtopInstance();
#endif
#ifdef NTOPNG_PRO
#ifdef WIN32
char* getIfName(int if_id, char *name, u_int name_len);
#else
inline NagiosManager* getNagios() { return(nagios_manager); };
#endif
#endif
void checkSystemScripts(ScriptPeriodicity p, lua_State *vm);
void checkSNMPDeviceAlerts(ScriptPeriodicity p, lua_State *vm);
void lua_periodic_activities_stats(NetworkInterface *iface, lua_State* vm);
void getUsers(lua_State* vm);
bool isUserAdministrator(lua_State* vm);
void getAllowedInterface(lua_State* vm);
void getAllowedNetworks(lua_State* vm);
bool getInterfaceAllowed(lua_State* vm, char *ifname) const;
bool isInterfaceAllowed(lua_State* vm, const char *ifname) const;
bool isInterfaceAllowed(lua_State* vm, int ifid) const;
bool isPcapDownloadAllowed(lua_State* vm, const char *ifname);
char *preparePcapDownloadFilter(lua_State* vm, char *filter);
bool isLocalUser(lua_State* vm);
bool checkCaptiveUserPassword(const char * const user, const char * const password, char *group) const;
bool checkGuiUserPassword(struct mg_connection *conn, const char * const user, const char * const password, char *group, bool *localuser) const;
bool isBlacklistedLogin(struct mg_connection *conn) const;
bool checkUserInterfaces(const char * const user) const;
bool resetUserPassword(char *username, char *old_password, char *new_password);
bool mustChangePassword(const char *user);
bool changeUserRole(char *username, char *user_role) const;
bool changeAllowedNets(char *username, char *allowed_nets) const;
bool changeAllowedIfname(char *username, char *allowed_ifname) const;
bool changeUserHostPool(const char * const username, const char * const host_pool_id) const;
bool changeUserLanguage(const char * const username, const char * const language) const;
bool changeUserPermission(const char * const username, bool allow_pcap_download) const;
bool getUserPermission(const char * const username, bool *allow_pcap_download) const;
bool existsUser(const char * const username) const;
bool addUser(char *username, char *full_name, char *password, char *host_role,
char *allowed_networks, char *allowed_ifname, char *host_pool_id,
char *language, bool allow_pcap_download);
bool addUserLifetime(const char * const username, u_int32_t lifetime_secs); /* Captive portal users may expire */
bool clearUserLifetime(const char * const username);
bool isCaptivePortalUser(const char * const username);
bool deleteUser(char *username);
bool getUserHostPool(char *username, u_int16_t *host_pool_id);
bool getUserAllowedIfname(const char * const username, char *buf, size_t buflen) const;
bool hasUserLimitedLifetime(const char * const username, int32_t *lifetime_secs);
void setWorkingDir(char *dir);
void fixPath(char *str, bool replaceDots = true);
void removeTrailingSlash(char *str);
void daemonize();
void shutdownPeriodicActivities();
void shutdown();
void shutdownAll();
void runHousekeepingTasks();
void runShutdownTasks();
inline bool isStarted() { return(is_started); }
bool isLocalInterfaceAddress(int family, void *addr) { return(local_interface_addresses.findAddress(family, addr) == -1 ? false : true); };
inline u_int8_t getLocalNetworkId(const char *network_name) { return(address->get_local_network_id(network_name)); }
inline char* getLocalNetworkName(int16_t local_network_id) {
return(address->get_local_network((u_int8_t)local_network_id));
};
void getLocalNetworkIp(int16_t local_network_id, IpAddress **network_ip, u_int8_t *network_prefix);
inline void addLocalNetwork(const char *network) { address->setLocalNetwork((char*)network); }
void createExportInterface();
void resetNetworkInterfaces();
void initElasticSearch();
void initLogstash();
inline u_int32_t getStarttime() { return((u_int32_t)start_time); }
inline char* getStarttimeString() { return(epoch_buf); }
inline u_int32_t getUptime() { return((u_int32_t)((start_time > 0) ? (time(NULL)-start_time) : 0)); }
inline int getUdpSock() { return(udp_socket); }
inline u_int getNumCPUs() { return(num_cpus); }
inline void setNumCPUs(u_int num) { num_cpus = num; }
inline NtopPro* getPro() { return((NtopPro*)pro); };
inline u_int8_t getNumLocalNetworks() { return(address->getNumLocalNetworks()); };
void loadTrackers();
bool isATrackerHost(char *host);
bool isExistingInterface(const char * const name) const;
inline NetworkInterface* getFirstInterface() { return(iface[0]); }
inline NetworkInterface* getInterface(int i) { return(((i < num_defined_interfaces) && iface[i]) ? iface[i] : NULL); }
inline NetworkInterface* getSystemInterface() { return(system_interface); }
#ifdef NTOPNG_PRO
bool addToNotifiedInformativeCaptivePortal(u_int32_t client_ip);
bool addIPToLRUMatches(u_int32_t client_ip, u_int16_t user_pool_id,
char *label, int32_t lifetime_secs, char *ifname);
#endif /* NTOPNG_PRO */
DeviceProtocolBitmask* getDeviceAllowedProtocols(DeviceType t) { return(&deviceProtocolPresets[t]); }
void refreshAllowedProtocolPresets(DeviceType t, bool client, lua_State *L, int index);
DeviceProtoStatus getDeviceAllowedProtocolStatus(DeviceType dev_type, ndpi_protocol proto, u_int16_t pool_id, bool as_client);
void refreshCpuLoad();
bool getCpuLoad(float *out);
inline void setLastInterfacenDPIReload(time_t now) { last_ndpi_reload = now; }
inline bool needsnDPICleanup() { return(ndpi_cleanup_needed); }
inline void setnDPICleanupNeeded(bool needed) { ndpi_cleanup_needed = needed; }
inline FifoStringsQueue* getSqliteAlertsQueue() { return(sqlite_alerts_queue); }
inline FifoStringsQueue* getAlertsNotificationsQueue() { return(alerts_notifications_queue); }
inline FifoSerializerQueue* getInternalAlertsQueue() { return(internal_alerts_queue); }
void sendNetworkInterfacesTermination();
inline time_t getLastStatsReset() { return(last_stats_reset); }
void resetStats();
inline void loadMaliciousJA3Hash(std::string md5_hash) { new_malicious_ja3->insert(md5_hash); }
bool isMaliciousJA3Hash(std::string md5_hash);
void reloadJA3Hashes();
struct ndpi_detection_module_struct* initnDPIStruct();
inline struct ndpi_detection_module_struct* get_ndpi_struct() const { return(ndpi_struct); };
bool startCustomCategoriesReload();
void checkReloadHostsBroadcastDomain();
inline bool isnDPIReloadInProgress() { return(ndpiReloadInProgress); }
void reloadCustomCategories();
void nDPILoadIPCategory(char *what, ndpi_protocol_category_t id);
void nDPILoadHostnameCategory(char *what, ndpi_protocol_category_t id);
inline ndpi_protocol_category_t get_ndpi_proto_category(ndpi_protocol proto) { return(ndpi_get_proto_category(get_ndpi_struct(), proto)); };
ndpi_protocol_category_t get_ndpi_proto_category(u_int protoid);
void setnDPIProtocolCategory(u_int16_t protoId, ndpi_protocol_category_t protoCategory);
inline void reloadPeriodicScripts() { if(pa) pa->reloadVMs(); };
};
extern Ntop *ntop;
#ifdef NTOPNG_PRO
#include "ntoppro_defines.h"
#endif
#endif /* _NTOP_CLASS_H_ */
Reference in a new issue View git blame Copy permalink