ntopng/include/NetworkInterface.h
Luca Deri e283806035 Extended Mac implementation with initial Lua export
Fixed bug in activity computation
2016-10-03 11:35:23 +02:00

399 lines
18 KiB
C++

/*
*
* (C) 2013-16 - 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 _NETWORK_INTERFACE_H_
#define _NETWORK_INTERFACE_H_
#include "ntop_includes.h"
/** @defgroup NetworkInterface Network Interface
* ............
*/
class Flow;
class FlowHash;
class Host;
class HostHash;
class Mac;
class MacHash;
class DB;
class Paginator;
#ifdef NTOPNG_PRO
class L7Policer;
#endif
/** @class NetworkInterface
* @brief Main class of network interface of ntopng.
* @details .......
*
* @ingroup NetworkInterface
*
*/
class NetworkInterface {
protected:
char *ifname; /**< Network interface name. */
char *remoteIfname, *remoteIfIPaddr, *remoteProbeIPaddr, *remoteProbePublicIPaddr;
string ip_addresses;
int id;
bool bridge_interface;
#ifdef NTOPNG_PRO
L7Policer *policer;
FlowProfiles *flow_profiles;
#endif
EthStats ethStats;
LocalTrafficStats localStats;
int pcap_datalink_type; /**< Datalink type of pcap. */
pthread_t pollLoop;
bool pollLoopCreated, tooManyHostsAlertTriggered, tooManyFlowsAlertTriggered, mtuWarningShown;
u_int32_t ifSpeed;
u_int16_t ifMTU;
int cpu_affinity; /**< Index of physical core where the network interface works. */
nDPIStats ndpiStats;
PacketStats pktStats;
FlowHash *flows_hash; /**< Hash used to store flows information. */
u_int32_t last_remote_pps, last_remote_bps;
/* Sub-interface views */
u_int8_t numSubInterfaces;
NetworkInterface *subInterfaces[MAX_NUM_VIEW_INTERFACES];
/* Lua */
bool reloadLuaInterpreter;
lua_State *L_flow_create_delete_ndpi, *L_flow_update;
/* Second update */
u_int64_t lastSecTraffic,
lastMinuteTraffic[60], /* Delta bytes (per second) of the last minute */
currentMinuteTraffic[60]; /* Delta bytes (per second) of the current minute */
time_t lastSecUpdate;
TcpFlowStats tcpFlowStats;
TcpPacketStats tcpPacketStats;
u_int64_t zmq_initial_bytes, zmq_initial_pkts;
/* Mac */
MacHash *macs_hash; /**< Hash used to store MAC information. */
/* Hosts */
HostHash *hosts_hash; /**< Hash used to store hosts information. */
bool purge_idle_flows_hosts, sprobe_interface, inline_interface,
dump_all_traffic, dump_to_tap, dump_to_disk, dump_unknown_traffic, dump_security_packets;
DB *db;
u_int dump_sampling_rate, dump_max_pkts_file, dump_max_duration, dump_max_files;
StatsManager *statsManager;
AlertsManager *alertsManager;
bool has_vlan_packets;
struct ndpi_detection_module_struct *ndpi_struct;
time_t last_pkt_rcvd, last_pkt_rcvd_remote, /* Meaningful only for ZMQ interfaces */
next_idle_flow_purge, next_idle_host_purge;
bool running, is_idle;
PacketDumper *pkt_dumper;
PacketDumperTuntap *pkt_dumper_tap;
NetworkStats *networkStats;
InterfaceStatsHash *interfaceStats;
lua_State* initLuaInterpreter(const char *lua_file);
void termLuaInterpreter();
void init();
void deleteDataStructures();
Flow* getFlow(u_int8_t *src_eth, u_int8_t *dst_eth, u_int16_t vlan_id,
u_int32_t deviceIP, u_int16_t inIndex, u_int16_t outIndex,
IpAddress *src_ip, IpAddress *dst_ip,
u_int16_t src_port, u_int16_t dst_port,
u_int8_t l4_proto,
bool *src2dst_direction,
time_t first_seen, time_t last_seen,
bool *new_flow);
int sortHosts(struct flowHostRetriever *retriever,
patricia_tree_t *allowed_hosts,
bool host_details,
LocationPolicy location,
char *countryFilter,
u_int16_t *vlan_id, char *osFilter,
u_int32_t *asnFilter, int16_t *networkFilter,
char *sortColumn);
int sortMacs(struct flowHostRetriever *retriever,
u_int16_t vlan_id, char *sortColumn);
bool isNumber(const char *str);
bool validInterface(char *name);
bool isInterfaceUp(char *name);
bool checkIdle();
void dumpPacketDisk(const struct pcap_pkthdr *h, const u_char *packet, dump_reason reason);
void dumpPacketTap(const struct pcap_pkthdr *h, const u_char *packet, dump_reason reason);
void triggerTooManyHostsAlert();
void triggerTooManyFlowsAlert();
virtual u_int getNumDroppedPackets() { return 0;};
bool walker(WalkerType wtype,
bool (*walker)(GenericHashEntry *h, void *user_data),
void *user_data);
void disablePurge(bool on_flows);
void enablePurge(bool on_flows);
u_int32_t getHostsHashSize();
u_int32_t getFlowsHashSize();
u_int32_t getMacsHashSize();
void sumStats(TcpFlowStats *_tcpFlowStats, EthStats *_ethStats,
LocalTrafficStats *_localStats, nDPIStats *_ndpiStats,
PacketStats *_pktStats, TcpPacketStats *_tcpPacketStats);
public:
/**
* @brief A Constructor
* @details Creating a new NeworkInteface with all instance variables set to NULL.
*
* @return A new instance of NetworkInteface.
*/
NetworkInterface();
NetworkInterface(const char *name);
virtual ~NetworkInterface();
inline void setCPUAffinity(int core_id) { cpu_affinity = core_id; };
virtual void startPacketPolling();
virtual void shutdown();
virtual void cleanup();
virtual char *getScriptName() { return NULL; }
virtual char *getEndpoint(u_int8_t id) { return NULL; };
virtual bool set_packet_filter(char *filter) { return(false); };
virtual void incrDrops(u_int32_t num) { ; }
inline virtual bool isPacketInterface() { return(true); }
inline virtual const char* get_type() { return(CONST_INTERFACE_TYPE_UNKNOWN); }
inline FlowHash *get_flows_hash() { return flows_hash; }
inline TcpFlowStats* getTcpFlowStats() { return(&tcpFlowStats); }
inline virtual bool is_ndpi_enabled() { return(true); }
inline u_int getNumnDPIProtocols() { return(ndpi_get_num_supported_protocols(ndpi_struct)); };
inline time_t getTimeLastPktRcvd() { return(last_pkt_rcvd); };
inline void setTimeLastPktRcvd(time_t t) { last_pkt_rcvd = t; };
inline char* get_ndpi_proto_name(u_int id) { return(ndpi_get_proto_name(ndpi_struct, id)); };
inline int get_ndpi_proto_id(char *proto) { return(ndpi_get_protocol_id(ndpi_struct, proto)); };
inline char* get_ndpi_proto_breed_name(u_int id) {
return(ndpi_get_proto_breed_name(ndpi_struct, ndpi_get_proto_breed(ndpi_struct, id))); };
inline void setRemoteIfname(char *name) { if(!remoteIfname) remoteIfname = strdup(name); };
inline void setRemoteIfIPaddr(char *ip) { if(!remoteIfIPaddr) remoteIfIPaddr = strdup(ip); };
inline void setRemoteProbeAddr(char *ip) { if(!remoteProbeIPaddr) remoteProbeIPaddr = strdup(ip);};
inline void setRemoteProbePublicAddr(char *ip) { if(!remoteProbePublicIPaddr) remoteProbePublicIPaddr = strdup(ip);};
inline u_int get_flow_size() { return(ndpi_detection_get_sizeof_ndpi_flow_struct()); };
inline u_int get_size_id() { return(ndpi_detection_get_sizeof_ndpi_id_struct()); };
inline char* get_name() { return(ifname); };
inline int get_id() { return(id); };
inline bool get_sprobe_interface() { return sprobe_interface; }
inline bool get_inline_interface() { return inline_interface; }
inline bool get_has_vlan_packets() { return has_vlan_packets; }
inline bool hasSeenVlanTaggedPackets() { return(has_vlan_packets); }
inline void setSeenVlanTaggedPackets() { has_vlan_packets = true; }
inline struct ndpi_detection_module_struct* get_ndpi_struct() { return(ndpi_struct); };
inline bool is_sprobe_interface() { return(sprobe_interface); };
inline bool is_purge_idle_interface() { return(purge_idle_flows_hosts); };
inline void enable_sprobe() { sprobe_interface = true; };
int dumpFlow(time_t when, bool partial_dump, Flow *f);
int dumpDBFlow(time_t when, bool partial_dump, Flow *f);
int dumpEsFlow(time_t when, bool partial_dump, Flow *f);
int dumpLocalHosts2redis(bool disable_purge);
inline void incRetransmittedPkts(u_int32_t num) { tcpPacketStats.incRetr(num); };
inline void incOOOPkts(u_int32_t num) { tcpPacketStats.incOOO(num); };
inline void incLostPkts(u_int32_t num) { tcpPacketStats.incLost(num); };
void resetSecondTraffic() { memset(currentMinuteTraffic, 0, sizeof(currentMinuteTraffic)); lastSecTraffic = 0, lastSecUpdate = 0; };
void updateSecondTraffic(time_t when);
inline void incStats(time_t when, u_int16_t eth_proto, u_int16_t ndpi_proto,
u_int pkt_len, u_int num_pkts, u_int pkt_overhead) {
ethStats.incStats(eth_proto, num_pkts, pkt_len, pkt_overhead);
ndpiStats.incStats(ndpi_proto, 0, 0, 1, pkt_len);
pktStats.incStats(pkt_len);
if(lastSecUpdate == 0) lastSecUpdate = when; else if(lastSecUpdate != when) updateSecondTraffic(when);
};
inline void incLocalStats(u_int num_pkts, u_int pkt_len, bool localsender, bool localreceiver) {
localStats.incStats(num_pkts, pkt_len, localsender, localreceiver);
};
inline EthStats* getStats() { return(&ethStats); };
inline int get_datalink() { return(pcap_datalink_type); };
inline void set_datalink(int l) { pcap_datalink_type = l; };
inline int isRunning() { return running; };
bool restoreHost(char *host_ip, u_int16_t vlan_id);
u_int printAvailableInterfaces(bool printHelp, int idx, char *ifname, u_int ifname_len);
void findFlowHosts(u_int16_t vlan_id,
u_int8_t src_mac[6], IpAddress *_src_ip, Host **src,
u_int8_t dst_mac[6], IpAddress *_dst_ip, Host **dst);
Flow* findFlowByKey(u_int32_t key, patricia_tree_t *allowed_hosts);
bool findHostsByName(lua_State* vm, patricia_tree_t *allowed_hosts, char *key);
bool dissectPacket(const struct pcap_pkthdr *h, const u_char *packet, bool *shaped, u_int16_t *ndpiProtocol);
bool processPacket(const struct bpf_timeval *when,
const u_int64_t time,
struct ndpi_ethhdr *eth,
u_int16_t vlan_id,
struct ndpi_iphdr *iph,
struct ndpi_ipv6hdr *ip6,
u_int16_t ipsize, u_int16_t rawsize,
const struct pcap_pkthdr *h,
const u_char *packet,
bool *shaped,
u_int16_t *ndpiProtocol);
void processFlow(ZMQ_Flow *zflow);
void processInterfaceStats(sFlowInterfaceStats *stats);
void dumpFlows();
void getnDPIStats(nDPIStats *stats);
void updateFlowsL7Policy(patricia_tree_t *ptree);
void periodicStatsUpdate();
virtual void lua(lua_State* vm);
void getnDPIProtocols(lua_State *vm);
/**
* @brief Returns host statistics during latest activity
* @details Local hosts statistics may be flushed to redis when they become inactive.
* When they become active again, redis-stored statistics are restored.
* There is a limited number of cases that only need host statistics during
* the latest activity. This is for example true when computing
* minute-by-minute top statistics.
*
* The function is handy to retrieve compact, unsorted host statistics
* without including deserialized values for total local host bytes (sent and received).
*
* @param vm The lua state.
* @param allowed_hosts A patricia tree containing allowed hosts.
*/
int getLatestActivityHostsList(lua_State* vm,
patricia_tree_t *allowed_hosts);
int getActiveHostsList(lua_State* vm,
patricia_tree_t *allowed_hosts,
bool host_details, LocationPolicy location,
char *countryFilter,
u_int16_t *vlan_id, char *osFilter, u_int32_t *asnFilter, int16_t *networkFilter,
char *sortColumn, u_int32_t maxHits,
u_int32_t toSkip, bool a2zSortOrder);
int getActiveHostsGroup(lua_State* vm,
patricia_tree_t *allowed_hosts,
bool host_details, LocationPolicy location,
char *countryFilter,
u_int16_t *vlan_id, char *osFilter,
u_int32_t *asnFilter, int16_t *networkFilter,
char *groupColumn);
int getActiveMacList(lua_State* vm, u_int16_t vlan_id,
char *sortColumn, u_int32_t maxHits,
u_int32_t toSkip, bool a2zSortOrder);
void getFlowsStats(lua_State* vm);
void getNetworksStats(lua_State* vm);
int getFlows(lua_State* vm, patricia_tree_t *allowed_hosts,
Host *host, int ndpi_proto, LocationPolicy location,
char *sortColumn, u_int32_t maxHits,
u_int32_t toSkip, bool a2zSortOrder);
int getFlows(lua_State* vm, patricia_tree_t *allowed_hosts,
LocationPolicy location, Host *host,
Paginator *p);
void getFlowPeersList(lua_State* vm, patricia_tree_t *allowed_hosts,
char *numIP, u_int16_t vlanId);
void getLocalHostActivity(lua_State* vm, const char * host);
void purgeIdle(time_t when);
u_int purgeIdleFlows();
u_int purgeIdleHostsMacs();
u_int64_t getNumPackets();
u_int64_t getNumBytes();
u_int getNumPacketDrops();
u_int getNumFlows();
u_int getNumHosts();
u_int getNumMacs();
u_int getNumHTTPHosts();
void runHousekeepingTasks();
Mac* getMac(u_int8_t _mac[6], u_int16_t vlanId, bool createIfNotPresent);
Host* getHost(char *host_ip, u_int16_t vlan_id);
bool getHostInfo(lua_State* vm, patricia_tree_t *allowed_hosts, char *host_ip, u_int16_t vlan_id);
bool loadHostAlertPrefs(lua_State* vm, patricia_tree_t *allowed_hosts, char *host_ip, u_int16_t vlan_id);
bool correlateHostActivity(lua_State* vm, patricia_tree_t *allowed_hosts, char *host_ip, u_int16_t vlan_id);
bool similarHostActivity(lua_State* vm, patricia_tree_t *allowed_hosts, char *host_ip, u_int16_t vlan_id);
void findUserFlows(lua_State *vm, char *username);
void findPidFlows(lua_State *vm, u_int32_t pid);
void findFatherPidFlows(lua_State *vm, u_int32_t pid);
void findProcNameFlows(lua_State *vm, char *proc_name);
void addAllAvailableInterfaces();
inline bool idle() { return(is_idle); }
inline u_int16_t getMTU() { return(ifMTU); }
inline void setIdleState(bool new_state) { is_idle = new_state; }
inline StatsManager *getStatsManager() { return statsManager; }
inline AlertsManager *getAlertsManager() { return alertsManager; }
void listHTTPHosts(lua_State *vm, char *key);
#ifdef NTOPNG_PRO
void refreshL7Rules(patricia_tree_t *ptree);
void refreshShapers();
inline L7Policer* getL7Policer() { return(policer); }
#endif
PacketDumper *getPacketDumper(void) { return pkt_dumper; }
PacketDumperTuntap *getPacketDumperTap(void) { return pkt_dumper_tap; }
void updateHostsL7Policy(patricia_tree_t *ptree);
bool updateDumpAllTrafficPolicy(void);
bool updateDumpTrafficDiskPolicy();
bool updateDumpTrafficTapPolicy();
int updateDumpTrafficSamplingRate();
int updateDumpTrafficMaxPktsPerFile();
int updateDumpTrafficMaxSecPerFile();
int updateDumpTrafficMaxFiles(void);
inline bool getDumpTrafficDiskPolicy() { return(dump_to_disk); }
inline bool getDumpTrafficTapPolicy() { return(dump_to_tap); }
inline u_int getDumpTrafficSamplingRate() { return(dump_sampling_rate); }
inline u_int getDumpTrafficMaxPktsPerFile() { return(dump_max_pkts_file); }
inline u_int getDumpTrafficMaxSecPerFile() { return(dump_max_duration); }
inline u_int getDumpTrafficMaxFiles() { return(dump_max_files); }
inline char* getDumpTrafficTapName() { return(pkt_dumper_tap ? pkt_dumper_tap->getName() : (char*)""); }
void loadDumpPrefs();
void getnDPIFlowsCount(lua_State *vm);
Host* findHostsByIP(patricia_tree_t *allowed_hosts,
char *host_ip, u_int16_t vlan_id);
inline HostHash* get_hosts_hash() { return(hosts_hash); }
inline MacHash* get_macs_hash() { return(macs_hash); }
inline bool is_bridge_interface() { return(bridge_interface); }
inline const char* getLocalIPAddresses() { return(ip_addresses.c_str()); }
void addInterfaceAddress(char *addr);
inline int exec_sql_query(lua_State *vm, char *sql, bool limit_rows) { return(db ? db->exec_sql_query(vm, sql, limit_rows) : -1); };
NetworkStats* getNetworkStats(u_int8_t networkId);
void allocateNetworkStats();
void getsDPIStats(lua_State *vm);
inline u_int64_t* getLastMinuteTrafficStats() { return((u_int64_t*)lastMinuteTraffic); }
#ifdef NTOPNG_PRO
void updateFlowProfiles(char *old_profile, char *new_profile);
inline FlowProfile* getFlowProfile(Flow *f) { return(flow_profiles ? flow_profiles->getFlowProfile(f) : NULL); }
inline bool checkProfileSyntax(char *filter) { return(flow_profiles ? flow_profiles->checkProfileSyntax(filter) : false); }
bool passShaperPacket(int a_shaper_id, int b_shaper_id, struct pcap_pkthdr *h);
#endif
void setRemoteStats(char *name, char *address, u_int32_t speedMbit,
char *remoteProbeAddress, char *remoteProbePublicAddress,
u_int64_t remBytes, u_int64_t remPkts, u_int32_t remote_time,
u_int32_t last_pps, u_int32_t last_bps);
void getFlowsStatus(lua_State *vm);
void startDBLoop() { if(db) db->startDBLoop(); };
inline bool createDBSchema() {if(db) {return db->createDBSchema();} return false;};
inline void getFlowDevices(lua_State *vm) { if(interfaceStats) interfaceStats->luaDeviceList(vm); else lua_newtable(vm); };
inline void getFlowDeviceInfo(lua_State *vm, u_int32_t deviceIP) { if(interfaceStats) interfaceStats->luaDeviceInfo(vm, deviceIP); else lua_newtable(vm); };
int luaEvalFlow(Flow *f, const LuaCallback cb);
inline void forceLuaInterpreterReload() { reloadLuaInterpreter = true; };
inline virtual bool isView() { return(false); };
bool getMacInfo(lua_State* vm, char *mac);
};
const char * getActivityName(UserActivityID id);
bool getActivityId(const char * name, UserActivityID * out);
#endif /* _NETWORK_INTERFACE_H_ */