id_name)) or filters filtered * * @param mixed $filter Array with filter conditions to retrieve filters or * false. * * @return array List of all filters. */ function netflow_get_filters($filter=false) { if ($filter === false) { $filters = db_get_all_rows_in_table('tnetflow_filter', 'id_name'); } else { $filters = db_get_all_rows_filter('tnetflow_filter', $filter); } $return = []; if ($filters === false) { return $return; } foreach ($filters as $filter) { $return[$filter['id_name']] = $filter['id_name']; } return $return; } /** * Selects all netflow reports (array (id_name => id_name)) or filters filtered * * @param mixed $filter Array with filter conditions to retrieve filters or * false. * * @return array List of all filters. */ function netflow_get_reports($filter=false) { if ($filter === false) { $filters = db_get_all_rows_in_table('tnetflow_report', 'id_name'); } else { $filters = db_get_all_rows_filter('tnetflow_report', $filter); } $return = []; if ($filters === false) { return $return; } foreach ($filters as $filter) { $return[$filter['id_name']] = $filter['id_name']; } return $return; } /** * Check if a filter owns to a certain group. * * @param integer $id_sg Id group to check. * * @return boolean True if user manages that group. */ function netflow_check_filter_group($id_sg) { global $config; $id_group = db_get_value('id_group', 'tnetflow_filter', 'id_sg', $id_sg); $own_info = get_user_info($config['id_user']); // Get group list that user has access. $groups_user = users_get_groups($config['id_user'], 'AR', $own_info['is_admin'], true); $groups_id = []; $has_permission = false; foreach ($groups_user as $key => $groups) { if ($groups['id_grupo'] == $id_group) { return true; } } return false; } /** * Get a filter. * * @param integer $id_sg Filter id to be fetched. * @param mixed $filter Extra filter. * @param mixed $fields Fields to be fetched. * * @return array A netflow filter matching id and filter. */ function netflow_filter_get_filter($id_sg, $filter=false, $fields=false) { if (! is_array($filter)) { $filter = []; } $filter['id_sg'] = (int) $id_sg; return db_get_row_filter('tnetflow_filter', $filter, $fields); } /** * Compare two flows according to the 'data' column. * * @param array $a First flow. * @param array $b Second flow. * * @return Result of the comparison. */ function compare_flows($a, $b) { return $a['data'] < $b['data']; } /** * Sort netflow data according to the 'data' column. * * @param array $netflow_data Netflow data array. * * @return void (Array passed by reference) */ function sort_netflow_data(&$netflow_data) { usort($netflow_data, 'compare_flows'); } /** * Show a table with netflow statistics. * * @param array $data Statistic data. * @param string $start_date Start date. * @param string $end_date End date. * @param string $aggregate Aggregate field. * * @return string HTML statistics table. */ function netflow_stat_table($data, $start_date, $end_date, $aggregate) { global $nfdump_date_format; $start_date = date($nfdump_date_format, $start_date); $end_date = date($nfdump_date_format, $end_date); $values = []; $table = new stdClass(); $table->width = '100%'; $table->cellspacing = 0; $table->class = 'info_table'; $table->data = []; $j = 0; $x = 0; $table->head = []; $table->head[0] = ''.netflow_format_aggregate($aggregate).''; $table->head[1] = ''.__('Value').''; $table->style[0] = 'padding: 6px;'; $table->style[1] = 'padding: 6px;'; while (isset($data[$j])) { $agg = $data[$j]['agg']; if (!isset($values[$agg])) { $values[$agg] = $data[$j]['data']; } else { $values[$agg] += $data[$j]['data']; } $table->data[$x][0] = $agg; $table->data[$x][1] = network_format_bytes($data[$j]['data']); $j++; $x++; } return html_print_table($table, true); } /** * Show a table with netflow data. * * @param array $data Netflow data. * @param string $start_date Start date. * @param string $end_date End date. * @param string $aggregate Aggregate field. * * @return string HTML data table. */ function netflow_data_table($data, $start_date, $end_date, $aggregate, $pdf=false) { global $nfdump_date_format; $period = ($end_date - $start_date); $start_date = date($nfdump_date_format, $start_date); $end_date = date($nfdump_date_format, $end_date); // Set the format. if ($period <= SECONDS_6HOURS) { $time_format = 'H:i:s'; } else if ($period < SECONDS_1DAY) { $time_format = 'H:i'; } else if ($period < SECONDS_15DAYS) { $time_format = 'M d H:i'; } else if ($period < SECONDS_1MONTH) { $time_format = 'M d H\h'; } else { $time_format = 'M d H\h'; } $values = []; $table = new stdClass(); if ($pdf === false) { $table->size = ['100%']; } $table->class = 'info_table w100p'; $table->cellspacing = 0; $table->data = []; $table->head = []; $table->head[0] = ''.__('Timestamp').''; $table->style[0] = 'padding: 4px'; $j = 0; $source_index = []; $source_count = 0; if (isset($data['sources'])) { foreach ($data['sources'] as $source => $null) { $table->style[($j + 1)] = 'padding: 4px'; $table->align[($j + 1)] = 'right'; $table->headstyle[($j + 1)] = 'text-align: right;'; $table->head[($j + 1)] = $source; $source_index[$j] = $source; $source_count++; $j++; } } else { $table->style[1] = 'padding: 4px;'; } // No aggregates. if ($source_count == 0) { $table->head[1] = __('Data'); $table->align[1] = 'right'; $i = 0; foreach ($data as $timestamp => $value) { $table->data[$i][0] = date($time_format, $timestamp); $table->data[$i][1] = network_format_bytes($value['data']); $i++; } } else { $i = 0; foreach ($data['data'] as $timestamp => $values) { $table->data[$i][0] = date($time_format, $timestamp); for ($j = 0; $j < $source_count; $j++) { $table->data[$i][($j + 1)] = network_format_bytes( $values[$source_index[$j]] ); } $i++; } } return html_print_table($table, true); } /** * Show a table with netflow top N data. * * @param array $data Netflow data. * @param integer $total_bytes Total bytes count to calculate percent data. * * @return string HTML data table. */ function netflow_top_n_table(array $data, int $total_bytes) { global $nfdump_date_format; $values = []; $table = new stdClass(); $table->class = 'info_table w100p'; $table->cellspacing = 0; $table->data = []; $table->head = []; $table->head[0] = ''.__('Source IP').''; $table->head[1] = ''.__('Destination IP').''; $table->head[2] = ''.__('Bytes').''; $table->head[3] = ''.__('% Traffic').''; $table->head[4] = ''.__('Avg. Throughput').''; $table->style[0] = 'padding: 4px'; $i = 0; foreach ($data as $value) { $table->data[$i][0] = $value['ip_src']; $table->data[$i][1] = $value['ip_dst']; $table->data[$i][2] = network_format_bytes($value['bytes']); $traffic = '-'; if ($total_bytes > 0) { $traffic = sprintf( '%.2f', (($value['bytes'] / $total_bytes) * 100) ); } $table->data[$i][3] = $traffic.' %'; $units = [ 'bps', 'Kbps', 'Mbps', 'Gbps', 'Tbps', ]; $pow = floor((($value['bps'] > 0) ? log($value['bps']) : 0) / log(1024)); $pow = min($pow, (count($units) - 1)); $value['bps'] /= pow(1024, $pow); $table->data[$i][4] = round($value['bps'], 2).' '.$units[$pow]; $i++; } return html_print_table($table, true); } /** * Show a table with a traffic summary. * * @param array $data Summary data. * * @return string HTML summary table. */ function netflow_summary_table($data) { global $nfdump_date_format; $values = []; $table = new stdClass(); $table->cellspacing = 0; $table->class = 'info_table'; $table->styleTable = 'width: 100%'; $table->data = []; $table->style[0] = 'font-weight: bold; padding: 6px'; $table->style[1] = 'padding: 6px'; $row = []; $row[] = __('Total flows'); $row[] = format_for_graph($data['totalflows'], 2); $table->data[] = $row; $row = []; $row[] = __('Total bytes'); $row[] = network_format_bytes($data['totalbytes']); $table->data[] = $row; $row = []; $row[] = __('Total packets'); $row[] = format_for_graph($data['totalpackets'], 2); $table->data[] = $row; $row = []; $row[] = __('Average bits per second'); $row[] = network_format_bytes($data['avgbps']); $table->data[] = $row; $row = []; $row[] = __('Average packets per second'); $row[] = format_for_graph($data['avgpps'], 2); $table->data[] = $row; $row = []; $row[] = __('Average bytes per packet'); $row[] = format_for_graph($data['avgbpp'], 2); $table->data[] = $row; $html = html_print_table($table, true); return $html; } /** * Returns 1 if the given address is a network address. * * @param string $address Host or network address. * * @return 1 if the address is a network address, 0 otherwise. */ function netflow_is_net($address) { if (strpos($address, '/') !== false) { return 1; } return 0; } /** * Returns netflow top N connections for the given period in an array (based on total traffic). * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param array $filter Netflow filter. * @param integer $max Maximum number of aggregates. * @param string $connection_name Node name when data is get in meta. * * @return array An array with netflow stats. */ function netflow_get_top_N( string $start_date, string $end_date, array $filter, int $max, string $connection_name='' ) { global $nfdump_date_format; // Requesting remote data. if (is_metaconsole() === true && empty($connection_name) === false) { $data = metaconsole_call_remote_api( $connection_name, 'netflow_get_top_N', $start_date.'|'.$end_date.'|'.base64_encode(json_encode($filter)).'|'.$max ); return json_decode($data, true); } $options = '-o "fmt:%sap,%dap,%ibyt,%bps" -q -n '.$max.' -s record/bytes -t '.date($nfdump_date_format, $start_date).'-'.date($nfdump_date_format, $end_date); $command = netflow_get_command($options, $filter, $start_date, $end_date); // Execute nfdump. exec($command, $lines); if (is_array($lines) === false) { return []; } $values = []; $i = 0; foreach ($lines as $line) { $parsed_line = explode(',', $line); $parsed_line = array_map('trim', $parsed_line); $values[$i]['ip_src'] = $parsed_line[0]; $values[$i]['ip_dst'] = $parsed_line[1]; $values[$i]['bytes'] = $parsed_line[2]; $values[$i]['bps'] = $parsed_line[3]; $i++; } return $values; } /** * Returns netflow data for the given period in an array. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param mixed $interval_length Resolution points or hourly or daily. * @param string $filter Netflow filter. * @param string $aggregate Aggregate field. * @param integer $max Maximum number of aggregates. * @param boolean $absolute True to give the absolute data and false * to get troughput. * @param string $connection_name Node name when data is get in meta. * @param boolean $address_resolution True to resolve ips to hostnames. * * @return array An array with netflow stats. */ function netflow_get_data( $start_date, $end_date, $interval_length, $filter, $aggregate, $max, $absolute, $connection_name='', $address_resolution=false, $network_format_bytes=false ) { global $nfdump_date_format; global $config; // Requesting remote data. if (defined('METACONSOLE') && $connection_name != '') { $data = metaconsole_call_remote_api( $connection_name, 'netflow_get_data', "$start_date|$end_date|$interval_length|".base64_encode(json_encode($filter))."|$aggregate|$max|1".(int) $address_resolution ); return json_decode($data, true); } if ($start_date > $end_date) { return []; } // Calculate the number of intervals. $multiplier_time = ($end_date - $start_date); switch ($interval_length) { case NETFLOW_RES_LOWD: case NETFLOW_RES_MEDD: case NETFLOW_RES_HID: case NETFLOW_RES_ULTRAD: $multiplier_time = ceil(($end_date - $start_date) / $interval_length); break; case NETFLOW_RES_HOURLY: $multiplier_time = SECONDS_1HOUR; break; case NETFLOW_RES_DAILY: $multiplier_time = SECONDS_1DAY; break; default: $multiplier_time = ($end_date - $start_date); break; } // Recalculate to not pass of netflow_max_resolution. if ($config['netflow_max_resolution'] > 0 && (($end_date - $start_date) / $multiplier_time) > 50 ) { $multiplier_time = ceil( (($end_date - $start_date) / $config['netflow_max_resolution']) ); } // Put all points into an array. $intervals = [($start_date - $multiplier_time)]; while (($next = (end($intervals) + $multiplier_time) < $end_date) === true) { $intervals[] = (end($intervals) + $multiplier_time); } if (end($intervals) != $end_date) { $intervals[] = $end_date; } // Calculate the top values. $values = netflow_get_top_data( $start_date, $end_date, $filter, $aggregate, $max ); // Update the filter to get properly next data. netflow_update_second_level_filter( $filter, $aggregate, array_keys($values['sources']) ); // Resolve addresses if required. $get_hostnames = false; if ($address_resolution === true) { global $hostnames; netflow_address_resolution($values, $get_hostnames, $aggregate); } foreach ($intervals as $k => $time) { $interval_start = $time; if (!isset($intervals[($k + 1)])) { continue; } $interval_end = $intervals[($k + 1)]; // Set default values. foreach ($values['sources'] as $source => $discard) { $values['data'][$interval_end][$source] = 0; } $data = netflow_get_stats( $interval_start, $interval_end, $filter, $aggregate, $max, $absolute, $connection_name, false, $start_date, $end_date ); foreach ($data as $line) { // Address resolution start. if ($get_hostnames) { if (!isset($hostnames[$line['agg']])) { $hostname = false; // Trying to get something like an IP from the description. if (preg_match('/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/', $line['agg'], $matches) || preg_match( "/(((?=(?>.*?(::))(?!.+\3)))\3?|([\dA-F]{1,4}(\3|:?)|\2))(?4){5}((?4){2}|(25[0-5]| (2[0-4]|1\d|[1-9])?\d)(\.(?7)){3})/i", $line['agg'], $matches ) ) { if ($matches[0]) { $hostname = gethostbyaddr($line['agg']); } } if ($hostname !== false) { $hostnames[$line['agg']] = $hostname; $line['agg'] = $hostname; } } else { $line['agg'] = $hostnames[$line['agg']]; } } // Address resolution end. if (! isset($values['sources'][$line['agg']])) { continue; } if ($network_format_bytes == true) { $pos = 0; $number = $line['data']; while ($number >= 1024) { // As long as the number can be divided by divider. $pos++; // Position in array starting with 0. $number = ($number / 1024); } while ($pos > 0) { $number = ($number * 1000); $pos--; } $values['data'][$interval_end][$line['agg']] = $number; } else { $values['data'][$interval_end][$line['agg']] = $line['data']; } } } if (empty($values['data'])) { return []; } return $values; } /** * Returns netflow stats for the given period in an array. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param string $filter Netflow filter. * @param string $aggregate Aggregate field. * @param integer $max Maximum number of aggregates. * @param boolean $absolute True to give the absolute data and false * to get troughput. * @param string $connection_name Node name when data is get in meta. * @param boolean $address_resolution True to resolve ips to hostnames. * @param integer $start_date_fixed Start date for use in command netflow. * @param integer $end_date_fixed End date for use in command netflow. * * @return array With netflow stats. */ function netflow_get_stats( $start_date, $end_date, $filter, $aggregate, $max, $absolute=true, $connection_name='', $address_resolution=false, $start_date_fixed=0, $end_date_fixed=0, ) { global $config, $nfdump_date_format; // Requesting remote data. if (is_metaconsole() === true && empty($connection_name) === false) { $data = metaconsole_call_remote_api($connection_name, 'netflow_get_stats', "$start_date|$end_date|".base64_encode(json_encode($filter))."|$aggregate|$max|$absolute|".(int) $address_resolution); return json_decode($data, true); } // Get the command to call nfdump. $options = "-o csv -q -n $max -s $aggregate/bytes -t ".date($nfdump_date_format, $start_date).'-'.date($nfdump_date_format, $end_date); $command = netflow_get_command($options, $filter, $start_date_fixed, $end_date_fixed); // Execute nfdump. exec($command, $string); if (is_array($string) === false) { return []; } // Remove the first line. $string[0] = ''; $i = 0; $values = []; $interval_length = ($end_date - $start_date); foreach ($string as $line) { if ($line == '') { continue; } $val = explode(',', $line); $values[$i]['date'] = $val[0]; $values[$i]['time'] = $val[1]; // Create field to sort array. $datetime = $val[0]; $end_date = strtotime($datetime); $values[$i]['datetime'] = $end_date; // Address resolution start. if ($address_resolution && ($aggregate == 'srcip' || $aggregate == 'dstip')) { global $hostnames; if (!isset($hostnames[$val[4]])) { $hostname = gethostbyaddr($val[4]); if ($hostname !== false) { $hostnames[$val[4]] = $hostname; $val[4] = $hostname; } } else { $val[4] = $hostnames[$val[4]]; } } // Address resolution end. $values[$i]['agg'] = $val[4]; if (! isset($val[9])) { return []; } $values[$i]['data'] = $val[9]; if (!$absolute) { $values[$i]['data'] = ($values[$i]['data'] / $interval_length); } $i++; } sort_netflow_data($values); return $values; } /** * Returns a traffic summary for the given period in an array. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param string $filter Netflow filter. * @param string $connection_name Node name when data is get in meta. * * @return array With netflow summary data. */ function netflow_get_summary($start_date, $end_date, $filter, $connection_name='') { global $nfdump_date_format; global $config; // Requesting remote data. if (is_metaconsole() === true && $connection_name != '') { $data = metaconsole_call_remote_api($connection_name, 'netflow_get_summary', "$start_date|$end_date|".base64_encode(json_encode($filter))); return json_decode($data, true); } // Get the command to call nfdump. $options = '-o csv -n 1 -s srcip/bytes -t '.date($nfdump_date_format, $start_date).'-'.date($nfdump_date_format, $end_date); $command = netflow_get_command($options, $filter, $start_date, $end_date); // Execute nfdump. exec($command, $string); if (! is_array($string) || ! isset($string[5])) { return []; } // Read the summary. $summary = explode(',', $string[5]); if (! isset($summary[5])) { return []; } $values['totalflows'] = $summary[0]; $values['totalbytes'] = $summary[1]; $values['totalpackets'] = $summary[2]; $values['avgbps'] = $summary[3]; $values['avgpps'] = $summary[4]; $values['avgbpp'] = $summary[5]; return $values; } /** * Returns a relationships data for the given period in an array. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param string $filter Netflow filter. * @param integer $max Maximum number of elements. * @param string $aggregate One of srcip, srcport, dstip, dstport. * * @return array With raw relationship data. */ function netflow_get_relationships_raw_data( $start_date, $end_date, $filter, $max, $aggregate ) { global $nfdump_date_format; global $config; $max_data = netflow_get_top_data( $start_date, $end_date, $filter, $aggregate, $max ); // Update src and dst filter (both). $sources_array = array_keys($max_data['sources']); $is_ip = netflow_aggregate_is_ip($aggregate); netflow_update_second_level_filter( $filter, ($is_ip === true) ? 'dstip' : 'dstport', $sources_array ); netflow_update_second_level_filter( $filter, ($is_ip === true) ? 'srcip' : 'srcport', $sources_array ); // Get the command to call nfdump. $options = ' -q -o csv -n 10000 -s record/bytes -t '.date($nfdump_date_format, $start_date).'-'.date($nfdump_date_format, $end_date); $command = netflow_get_command($options, $filter, $start_date, $end_date); // Execute nfdump. // $command .= ' -q -o csv -n 10000 -s record/bytes -t '.date($nfdump_date_format, $start_date).'-'.date($nfdump_date_format, $end_date); exec($command, $result); if (! is_array($result)) { return [ 'lines' => [], 'sources' => [], ]; } return [ 'lines' => $result, 'sources' => $sources_array, ]; } /** * Parse the raw relationships data to be painted by circular mesh chart. * * @param array $result Lines gotten from nfdump call. * @param array $sources_array Array with sources involved in the chart. * @param boolean $is_ip Is ip or port. * * @return array With data to be parsed on circular mesh chart. */ function netflow_parse_relationships_for_circular_mesh( $result, $sources_array, $is_ip ) { if (empty($result)) { return []; } // Initialize some data structures. $data = [ 'elements' => [], 'matrix' => [], ]; $initial_data = []; // This array has the ips or port like keys and the array position as value. $inverse_sources_array = array_flip($sources_array); foreach ($sources_array as $sdata) { $data['elements'][$inverse_sources_array[$sdata]] = $sdata; $initial_data[$inverse_sources_array[$sdata]] = 0; } foreach ($sources_array as $sdata) { $data['matrix'][$inverse_sources_array[$sdata]] = $initial_data; } // Port are situated in a different places from addreses. $src_key = ($is_ip === true) ? 3 : 5; $dst_key = ($is_ip === true) ? 4 : 6; // Store a footprint of initial data to be compared at the end. $freeze_data = md5(serialize($data)); foreach ($result as $line) { if (empty($line) === true) { continue; } // Parse the line. $items = explode(',', $line); // Get the required data. $src_item = $inverse_sources_array[$items[$src_key]]; $dst_item = $inverse_sources_array[$items[$dst_key]]; $value = $items[12]; // Check if valid data. if (!isset($value) || !isset($data['matrix'][$dst_item][$src_item]) || !isset($data['matrix'][$src_item][$dst_item]) ) { continue; } // Update the value. $data['matrix'][$src_item][$dst_item] += (int) $value; } // Comparte footprints. if ($freeze_data === md5(serialize($data))) { // Taht means that all relationships are 0. return []; } return $data; } /** * Returns the command needed to run nfdump for the given filter. * * @param array $filter Netflow filter. * * @return string Command to run. */ function netflow_get_command($options, $filter, $date_init=0, $date_end=0) { global $config; // Build command. $command = io_safe_output($config['netflow_nfdump']).' -N'; if ($config['activate_sflow'] && $config['activate_netflow']) { if (isset($config['sflow_name_dir']) && $config['sflow_name_dir'] !== '' && isset($config['netflow_name_dir']) && $config['netflow_name_dir'] !== '' && isset($config['general_network_path']) && $config['general_network_path'] !== '' ) { if ($date_init > 0 && $date_end > 0) { $path = $config['general_network_path'].$config['sflow_name_dir']; $range_time = find_range_files_time($path, $date_init, $date_end); if ($range_time[0] === 0 && $range_time[1] === 0) { $interval_files_sflow = $path; } else { $interval_files_sflow = $path.'/'.$range_time[0].':'.$range_time[1]; } $path = $config['general_network_path'].$config['netflow_name_dir']; $range_time = find_range_files_time($path, $date_init, $date_end); if ($range_time[0] === 0 && $range_time[1] === 0) { $interval_files_netflow = $path; } else { $interval_files_netflow = $path.'/'.$range_time[0].':'.$range_time[1]; } $command .= ' -R '.$interval_files_sflow.' -R '.$interval_files_netflow; } else { $command .= ' -R. -M '.$config['general_network_path'].$config['netflow_name_dir'].':'.$config['sflow_name_dir']; } } } else { if ($config['activate_sflow']) { if (isset($config['sflow_name_dir']) && $config['sflow_name_dir'] !== '' && isset($config['general_network_path']) && $config['general_network_path'] !== '' ) { if ($date_init > 0 && $date_end > 0) { $path = $config['general_network_path'].$config['sflow_name_dir']; $range_time = find_range_files_time($path, $date_init, $date_end); if ($range_time[0] === 0 && $range_time[1] === 0) { $interval_files = '.'; } else { $interval_files = $range_time[0].':'.$range_time[1]; } } else { $interval_files = '.'; } $command .= ' -R '.$interval_files.' -M '.$config['general_network_path'].$config['sflow_name_dir']; } } if ($config['activate_netflow']) { if (isset($config['netflow_name_dir']) && $config['netflow_name_dir'] !== '' && isset($config['general_network_path']) && $config['general_network_path'] !== '' ) { if ($date_init > 0 && $date_end > 0) { $path = $config['general_network_path'].$config['netflow_name_dir']; $range_time = find_range_files_time($path, $date_init, $date_end); if ($range_time[0] === 0 && $range_time[1] === 0) { $interval_files = '.'; } else { $interval_files = $range_time[0].':'.$range_time[1]; } } else { $interval_files = '.'; } $command .= ' -R '.$interval_files.' -M '.$config['general_network_path'].$config['netflow_name_dir']; } } } // Add options. $command .= ' '.$options; // Filter options. $command .= ' '.netflow_get_filter_arguments($filter); return $command; } /** * Find the two files closest to the time range. * * @param string $folder Folder of netflow. * @param integer $date_init Time init for range. * @param integer $date_end Time end for range. * * @return array */ function find_range_files_time($folder, $date_init, $date_end) { $closest_init = 0; $closest_end = 0; $closest_init_date = 0; $closest_end_date = 0; $min_diff_init = PHP_INT_MAX; $min_diff_end = PHP_INT_MAX; $files = scandir($folder); if ($date_init > 0) { foreach ($files as $file) { if (preg_match('/^nfcapd\.(\d{12})$/', $file, $matches)) { $file_date = $matches[1]; $file_date = strtotime(substr($file_date, 0, 4).'-'.substr($file_date, 4, 2).'-'.substr($file_date, 6, 2).' '.substr($file_date, 8, 2).':'.substr($file_date, 10, 2)); $diff_init = abs($file_date - $date_init); if ($diff_init < $min_diff_init) { $closest_init_date = $file_date; $min_diff_init = $diff_init; $closest_init = $file; } $diff_end = abs($file_date - $date_end); if ($diff_end < $min_diff_end) { $closest_end_date = $file_date; $min_diff_end = $diff_end; $closest_end = $file; } } } } if ($closest_end_date < $date_init || $closest_init_date > $date_end) { return [ 0, 0, ]; } else { return [ $closest_init, $closest_end, ]; } } /** * Returns the nfdump command line arguments that match the given filter. * * @param array $filter Netflow filter. * * @return string Command line argument string. */ function netflow_get_filter_arguments($filter, $safe_input=false) { // Advanced filter. $filter_args = ''; if ($filter['advanced_filter'] != '') { $filter_args = preg_replace('/["\r\n]/', '', io_safe_output($filter['advanced_filter'])); } else { if ($filter['router_ip'] != '') { $filter_args .= ' (router ip '.$filter['router_ip'].')'; } // Normal filter. if ($filter['ip_dst'] != '') { if ($filter_args != '') { $filter_args .= ' and ('; } else { $filter_args .= ' ('; } $val_ipdst = explode(',', io_safe_output($filter['ip_dst'])); for ($i = 0; $i < count($val_ipdst); $i++) { if ($i > 0) { $filter_args .= ' or '; } if (netflow_is_net($val_ipdst[$i]) == 0) { $filter_args .= 'dst ip '.$val_ipdst[$i]; } else { $filter_args .= 'dst net '.$val_ipdst[$i]; } } $filter_args .= ')'; } if ($filter['ip_src'] != '') { if ($filter_args == '') { $filter_args .= ' ('; } else { $filter_args .= ' and ('; } $val_ipsrc = explode(',', io_safe_output($filter['ip_src'])); for ($i = 0; $i < count($val_ipsrc); $i++) { if ($i > 0) { $filter_args .= ' or '; } if (netflow_is_net($val_ipsrc[$i]) == 0) { $filter_args .= 'src ip '.$val_ipsrc[$i]; } else { $filter_args .= 'src net '.$val_ipsrc[$i]; } } $filter_args .= ')'; } if ($filter['dst_port'] != '') { if ($filter_args == '') { $filter_args .= ' ('; } else { $filter_args .= ' and ('; } $val_dstport = explode(',', io_safe_output($filter['dst_port'])); for ($i = 0; $i < count($val_dstport); $i++) { if ($i > 0) { $filter_args .= ' or '; } $filter_args .= 'dst port '.$val_dstport[$i]; } $filter_args .= ')'; } if ($filter['src_port'] != '') { if ($filter_args == '') { $filter_args .= ' ('; } else { $filter_args .= ' and ('; } $val_srcport = explode(',', io_safe_output($filter['src_port'])); for ($i = 0; $i < count($val_srcport); $i++) { if ($i > 0) { $filter_args .= ' or '; } $filter_args .= 'src port '.$val_srcport[$i]; } $filter_args .= ')'; } if (isset($filter['proto']) && $filter['proto'] != '') { if ($filter_args == '') { $filter_args .= ' ('; } else { $filter_args .= ' and ('; } $val_proto = explode(',', io_safe_output($filter['proto'])); for ($i = 0; $i < count($val_proto); $i++) { if ($i > 0) { $filter_args .= ' or '; } $filter_args .= 'proto '.$val_proto[$i]; } $filter_args .= ')'; } } if ($filter_args != '') { $filter_args = ($safe_input === true) ? io_safe_input(escapeshellarg($filter_args)) : escapeshellarg($filter_args); } return $filter_args; } /** * Get the types of netflow charts. * * @return array of types. */ function netflow_get_chart_types() { return [ 'netflow_area' => __('Area graph'), 'netflow_summary' => __('Summary'), 'netflow_data' => __('Data table'), 'netflow_top_N' => __('Top-N connections'), 'netflow_mesh' => __('Circular mesh'), 'netflow_host_treemap' => __('Host detailed traffic'), ]; } /** * Draw a netflow report item. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param mixed $interval_length Resolution points or hourly or daily. * @param string $type Chart type. * @param array $filter Netflow filter. * @param integer $max_aggregates Maximum number of aggregates. * @param string $connection_name Node name when data is get in meta. * @param string $output Output format. Only HTML, PDF and XML * are supported. * @param boolean $address_resolution True to resolve ips to hostnames. * * @return string The netflow report in the appropriate format. */ function netflow_draw_item( $start_date, $end_date, $interval_length, $type, $filter, $max_aggregates, $connection_name='', $output='HTML', $address_resolution=false, $width_content=false, $height_content=false ) { $aggregate = $filter['aggregate']; $interval = ($end_date - $start_date); if (is_metaconsole() === true) { $width = 950; } else { $width = 850; } $height = 320; // Process item. switch ($type) { case 'netflow_area': $data = netflow_get_data( $start_date, $end_date, $interval_length, $filter, $aggregate, $max_aggregates, true, $connection_name, $address_resolution, true ); if (empty($data) === true) { break; } if ($output === 'HTML' || $output === 'PDF') { return graph_netflow_aggregate_area( $data, $interval, $width, $height, ($output === 'HTML') ? 1 : 2, ($output === 'HTML'), $end_date ); } else if ($output === 'XML') { $xml = ''.$aggregate."\n"; $xml .= ''.$interval_length."\n"; $xml .= netflow_aggregate_area_xml($data); return $xml; } break; case 'netflow_data': $data = netflow_get_data( $start_date, $end_date, $interval_length, $filter, $aggregate, $max_aggregates, true, $connection_name, $address_resolution ); if (empty($data) === true) { break; } if ($output === 'HTML' || $output === 'PDF') { $html = "
"; $html .= netflow_data_table($data, $start_date, $end_date, $aggregate, $output === 'PDF'); $html .= '
'; return $html; } else if ($output === 'XML') { $xml = ''.$aggregate."\n"; $xml .= ''.$interval_length."\n"; // Same as netflow_aggregate_area_xml. $xml .= netflow_aggregate_area_xml($data); return $xml; } break; case 'netflow_summary': $data_summary = netflow_get_summary( $start_date, $end_date, $filter, $connection_name ); if (empty($data_summary)) { break; } $data_pie = netflow_get_stats( $start_date, $end_date, $filter, $aggregate, $max_aggregates, true, $connection_name, $address_resolution, $start_date, $end_date ); if (empty($data_pie) === true) { break; } if ($output === 'HTML' || $output === 'PDF') { $html = ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= '
'; $html .= netflow_summary_table($data_summary); $html .= ''; $html .= graph_netflow_aggregate_pie( $data_pie, netflow_format_aggregate($aggregate), ($output === 'HTML') ? 1 : 2, ($output === 'HTML') ); $html .= '
'; $html .= netflow_stat_table( $data_pie, $start_date, $end_date, $aggregate ); return $html; } else if ($output === 'XML') { return netflow_summary_xml($data_summary, $data_pie); } break; case 'netflow_top_N': $data_summary = netflow_get_summary( $start_date, $end_date, $filter, $connection_name ); if (empty($data_summary) === true) { break; } $data_top_n = netflow_get_top_N( $start_date, $end_date, $filter, $max_aggregates, $connection_name ); if (empty($data_top_n) === true) { break; } if ($output === 'HTML' || $output === 'PDF') { $html = ''; $html .= ''; $html .= "'; $html .= ''; $html .= ''; $html .= "'; $html .= ''; $html .= '
"; $html .= netflow_summary_table($data_summary); $html .= '
"; $html .= netflow_top_n_table($data_top_n, $data_summary['totalbytes']); $html .= '
'; return $html; } else if ($output === 'XML') { $xml = ''.$aggregate."\n"; $xml .= ''.$interval_length."\n"; // Same as netflow_aggregate_area_xml. $xml .= netflow_aggregate_area_xml($data_top_n); return $xml; } break; case 'netflow_mesh': $data = netflow_get_relationships_raw_data( $start_date, $end_date, $filter, $max_aggregates, $aggregate, $address_resolution ); $data_circular = netflow_parse_relationships_for_circular_mesh( $data['lines'], $data['sources'], netflow_aggregate_is_ip($aggregate) ); $data_circular['width'] = $width_content; $data_circular['height'] = $height_content; $html = '
'; $html .= graph_netflow_circular_mesh($data_circular); $html .= '
'; return $html; case 'netflow_host_treemap': $data_stats = netflow_get_stats( $start_date, $end_date, $filter, $aggregate, $max_aggregates, true, $connection_name, $address_resolution, $start_date, $end_date ); if (empty($data_stats) === false) { switch ($aggregate) { case 'srcip': case 'srcport': $address_type = 'source_address'; $port_type = 'source_port'; $type = __('Sent'); break; default: case 'dstip': case 'dstport': $address_type = 'destination_address'; $port_type = 'destination_port'; $type = __('Received'); break; } $data_graph = [ 'name' => __('Host detailed traffic').': '.$type, 'children' => [], ]; $id = -1; foreach ($data_stats as $sdata) { $data_graph['children'][] = [ 'id' => $id++, 'name' => $sdata['agg'], 'children' => [ [ 'id' => $id++, 'name' => $sdata['agg'], 'value' => $sdata['data'], 'tooltip_content' => network_format_bytes($sdata['data']), ], ], ]; } return graph_netflow_host_traffic($data_graph, 'auto', 400); } break; default: // Nothing to do. break; } if ($output === 'HTML' || $output === 'PDF') { return graph_nodata_image(['height' => 110]); } } /** * Get data of a netflow report item. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param mixed $interval_length Resolution points or hourly or daily. * @param string $type_netflow Period end date. * @param array $filter Netflow filter. * @param integer $max_aggregates Maximum number of aggregates. * @param string $connection_name Node name when data is get in meta. * * @return array Netflow item data (summary and top N data). */ function netflow_get_item_data( string $start_date, string $end_date, $interval_length, string $type_netflow, array $filter, int $max_aggregates, string $connection_name ) { $data = []; switch ($type_netflow) { case 'netflow_top_N': $data_summary = netflow_get_summary( $start_date, $end_date, $filter, $connection_name ); $data_top_n = netflow_get_top_N( $start_date, $end_date, $filter, $max_aggregates, $connection_name ); $data = [ 'summary' => $data_summary, 'top_n' => $data_top_n, ]; break; case 'netflow_summary': $aggregate = $filter['aggregate']; $data_summary = netflow_get_summary( $start_date, $end_date, $filter, $connection_name ); $data_stats = netflow_get_stats( $start_date, $end_date, $filter, $aggregate, $max_aggregates, true, $connection_name, $start_date, $end_date ); $data = [ 'summary' => $data_summary, 'stats' => $data_stats, ]; break; default: $aggregate = $filter['aggregate']; $data = netflow_get_data( $start_date, $end_date, $interval_length, $filter, $aggregate, $max_aggregates, true, $connection_name ); break; } return $data; } /** * Render a summary table as an XML. * * @param array $data Netflow data. * @param array $rows_data Table info (top N hosts). * * @return string Wiht XML data. */ function netflow_summary_xml($data, $rows_data) { // Print summary. $xml = "\n"; $xml = " \n"; $xml .= ' '.$data['totalflows']."\n"; $xml .= ' '.$data['totalbytes']."\n"; $xml .= ' '.$data['totalbytes']."\n"; $xml .= ' '.$data['avgbps']."\n"; $xml .= ' '.$data['avgpps']."\n"; $xml .= ' '.$data['avgpps']."\n"; $xml .= " \n"; // Add the data table. $xml .= " \n"; foreach ($rows_data as $d) { $xml .= "\n"; $xml .= ''.$d['agg']."\n"; $xml .= ''.$d['data']."\n"; $xml .= "\n"; } $xml .= " \n"; $xml .= "\n"; return $xml; } /** * Return a string describing the given aggregate. * * @param string $aggregate Netflow aggregate. * * @return string With formatted aggregate. */ function netflow_format_aggregate($aggregate) { switch ($aggregate) { case 'dstport': return __('Dst port'); case 'dstip': return __('Dst IP'); case 'srcip': return __('Src IP'); case 'srcport': return __('Src port'); default: return ''; } } /** * Check the nfdump binary for compatibility. * * @param string $nfdump_binary Nfdump binary full path. * * @return integer 1 if the binary does not exist or is not executable, 2 if a * version older than 1.6.8 is installed or the version cannot be * determined, 0 otherwise. */ function netflow_check_nfdump_binary($nfdump_binary) { // Check that the binary exists and is executable. if (! is_executable($nfdump_binary)) { return 1; } // Check at least version 1.6.8. $output = ''; $rc = -1; exec($nfdump_binary.' -V', $output, $rc); if ($rc != 0) { return 2; } $matches = []; foreach ($output as $line) { if (preg_match('/Version:[^\d]+(\d+)\.(\d+)\.(\d+)/', $line, $matches) === 1) { if ($matches[1] < 1) { return 2; } if ($matches[2] < 6) { return 2; } if ($matches[3] < 8) { return 2; } return 0; } } return 2; } /** * Get the netflow datas to build a netflow explorer data structure. * * @param integer $max Number of result displayed. * @param string $top_action Action to do (listeners,talkers,tcp or udp). * @param integer $start_date In utimestamp. * @param integer $end_date In utimestamp. * @param string $filter Ip to filter. * @param string $order Select one of bytes,pkts,flow. * * @return array With data (host, sum_bytes, sum_pkts and sum_flows). */ function netflow_get_top_summary( $max, $top_action, $start_date, $end_date, $filter='', $order='bytes' ) { global $nfdump_date_format; $netflow_filter = []; $sort = ''; switch ($top_action) { case 'listeners': if (empty(!$filter)) { if (!is_array($filter)) { $netflow_filter['ip_src'] = $filter; } else { $netflow_filter['ip_src'] = $filter['ip']; $netflow_filter['advanced_filter'] = $filter['advanced_filter']; } } $sort = 'dstip'; break; case 'talkers': if (empty(!$filter)) { if (!is_array($filter)) { $netflow_filter['ip_dst'] = $filter; } else { $netflow_filter['ip_dst'] = $filter['ip']; $netflow_filter['advanced_filter'] = $filter['advanced_filter']; } } $sort = 'srcip'; break; case 'tcp': case 'udp': $netflow_filter['proto'] = $top_action; $sort = 'port'; if (empty(!$filter)) { $netflow_filter['advanced_filter'] = sprintf( '((dst port %s) or (src port %s)) and (proto %s)', $filter, $filter, $top_action ); // Display ips when filter is set in port. $sort = 'ip'; } break; default: return []; } // Execute nfdump. $order_text = ''; switch ($order) { case 'flows': $order_text = 'flows'; break; case 'pkts': $order_text = 'packets'; break; case 'bytes': default: $order_text = 'bytes'; break; } $options = "-q -o csv -n $max -s $sort/$order_text -t ".date($nfdump_date_format, $start_date).'-'.date($nfdump_date_format, $end_date); $command = netflow_get_command($options, $netflow_filter, $start_date, $end_date); exec($command, $result); if (! is_array($result)) { return []; } // Remove first line (avoiding slow array_shift). $result = array_reverse($result); array_pop($result); $result = array_reverse($result); $top_info = []; foreach ($result as $line) { if (empty($line)) { continue; } $data = explode(',', $line); if (!isset($data[9])) { continue; } $top_info[(string) $data[4]] = [ 'host' => $data[4], 'sum_bytes' => $data[9], 'sum_pkts' => $data[7], 'sum_flows' => $data[5], 'pct_bytes' => $data[10], 'pct_pkts' => $data[8], 'pct_flows' => $data[6], ]; } return $top_info; } /** * Check the netflow version and print an error message if there is not correct. * * @return boolean True if version check is correct. */ function netflow_print_check_version_error() { global $config; switch (netflow_check_nfdump_binary($config['netflow_nfdump'])) { case 0: return true; case 1: ui_print_error_message( __('nfdump binary (%s) not found!', $config['netflow_nfdump']) ); return false; case 2: default: ui_print_error_message( __('Make sure nfdump version 1.6.8 or newer is installed!') ); return false; } } /** * Returns the array for netflow resolution select. * * @return array With all values. */ function netflow_resolution_select_params() { return [ NETFLOW_RES_LOWD => __('Low'), NETFLOW_RES_MEDD => __('Medium'), NETFLOW_RES_HID => __('High'), NETFLOW_RES_ULTRAD => __('Ultra High'), NETFLOW_RES_HOURLY => __('Hourly'), NETFLOW_RES_DAILY => __('Daily'), ]; } /** * Get the resolution name. * * @param mixed $value Type. * * @return string Translated name. Unknown for unrecognized resolution names. */ function netflow_get_resolution_name($value) { $resolutions = netflow_resolution_select_params(); return (isset($resolutions[$value])) ? $resolutions[$value] : __('Unknown'); } /** * Report formatted subtitle. * * @param string $aggregate Aggregate by param. * @param string $resolution Netfow live view resolution. * @param string $type Type of view. * * @return string HTML with formatted subtitle. */ function netflow_generate_subtitle_report($aggregate, $resolution, $type) { $subt = __( 'Agregate by %s', netflow_format_aggregate($aggregate) ); // Display the resolution only in required reports. if (in_array($type, ['netflow_area', 'netflow_data']) === true) { $subt .= ' - '; $subt .= __( 'Resolution %s', netflow_get_resolution_name($resolution) ); } return $subt; } /** * Returns netflow stats for the given period in an array. * * @param string $start_date Period start date. * @param string $end_date Period end date. * @param string $filter Netflow filter. * @param string $aggregate Aggregate field. * @param integer $max Maximum number of aggregates. * * @return array With netflow stats. */ function netflow_get_top_data( $start_date, $end_date, $filter, $aggregate, $max ) { global $nfdump_date_format; $values = [ 'data' => [], 'sources' => [], ]; // Get the command to call nfdump. $options = sprintf( '-q -o csv -n %s -s %s/bytes -t %s-%s', $max, $aggregate, date($nfdump_date_format, $start_date), date($nfdump_date_format, $end_date) ); $agg_command = netflow_get_command($options, $filter, $start_date, $end_date); // Call nfdump. exec($agg_command, $string); // Remove the first line. $string[0] = ''; // Parse aggregates. foreach ($string as $line) { if (empty($line) === true) { continue; } $val = explode(',', $line); $values['sources'][$val[4]] = 1; } return $values; } /** * Returns netflow stats for the given period in an array. * * @param string $filter Netflow filter (passed by reference). * @param string $aggregate Aggregate field. * @param array $sources Sources to aggregate to filter. * * @return void $filter is passed by reference. */ function netflow_update_second_level_filter(&$filter, $aggregate, $sources) { // Update the filter. switch ($aggregate) { default: case 'srcip': $extra_filter = 'ip_src'; break; case 'srcport': $extra_filter = 'src_port'; break; case 'dstip': $extra_filter = 'ip_dst'; break; case 'dstport': $extra_filter = 'dst_port'; break; } if (isset($filter[$extra_filter]) && $filter[$extra_filter] != '') { $filter[$extra_filter] .= ','; } if (!empty($sources)) { $filter[$extra_filter] = implode(',', $sources); } } /** * Change some values on address resolve. * * @param array $values Where data will be overwritten (ref). * @param boolean $get_hostnames Change it if address resolution es done (ref). * @param string $aggregate One of srcip, srcport, dstip, dstport. * * @return void Referenced passed params will be changed. */ function netflow_address_resolution(&$values, &$get_hostnames, $aggregate) { if ($aggregate !== 'srcip' && $aggregate !== 'dstip') { return; } $get_hostnames = true; global $hostnames; $sources = []; foreach ($values['sources'] as $source => $value) { if (!isset($hostnames[$source])) { $hostname = gethostbyaddr($source); if ($hostname !== false) { $hostnames[$source] = $hostname; $source = $hostname; } } else { $source = $hostnames[$source]; } $sources[$source] = $value; } $values['sources'] = $sources; } /** * Check if is aggregate by IP or by port * * @param string $aggregate Aggregate tag. * * @return boolean True if is IP. False for port. */ function netflow_aggregate_is_ip($aggregate) { return in_array($aggregate, ['dstip', 'srcip']); } /** * Build netflow data structure to network map. * * @param integer $start_date Time in timestamp format. * @param integer $end_date Time in timestamp format. * @param integer $top Max data to show. * @param integer $aggregate One of dstip or srcip. * * @return array With map structure. */ function netflow_build_map_data($start_date, $end_date, $top, $aggregate, $advanced_filter='') { // Pass an empty filter data structure. $data = netflow_get_relationships_raw_data( $start_date, $end_date, [ 'id_name' => '', 'id_group' => 0, 'aggregate' => $aggregate, 'id_dst' => '', 'ip_src' => '', 'dst_port' => '', 'src_port' => '', 'advanced_filter' => $advanced_filter, 'router_ip' => '', ], $top, $aggregate ); $nodes = array_map( function ($elem) { return network_init_node_map($elem); }, array_merge($data['sources'], [__('Others')]) ); $relations = []; $inverse_nodes = array_flip($data['sources']); // Port are situated in a different places from addreses. $is_ip = true; $src_key = ($is_ip === true) ? 3 : 5; $dst_key = ($is_ip === true) ? 4 : 6; $retrieved_data = array_fill_keys($inverse_nodes, false); foreach ($data['lines'] as $line) { if (empty($line) === true) { continue; } // Parse the line. $items = explode(',', $line); // Get the required data. $src_item = $inverse_nodes[$items[$src_key]]; $dst_item = $inverse_nodes[$items[$dst_key]]; $value = $items[12]; $index_rel = $src_item.'-'.$dst_item; // Check if valid data. if (!isset($value) || (!isset($src_item) && !isset($dst_item))) { continue; } // Mark as connected source and destination. $retrieved_data[$src_item] = true; $retrieved_data[$dst_item] = true; if (isset($relations[$index_rel])) { $relations[$index_rel]['text_start'] += $value; } else { // Update the value. network_init_relation_map($relations, $src_item, $dst_item, $value); } } // Format the data in edges. array_walk( $relations, function (&$elem) { $elem['text_start'] = network_format_bytes($elem['text_start']); } ); // Search for orphan nodes. $orphan_hosts = []; $orphan_index = (end($inverse_nodes) + 1); foreach ($retrieved_data as $position => $rd) { if ($rd === true) { continue; } network_init_relation_map($orphan_hosts, $position, $orphan_index); } // If there is not any orphan node, delete it. if (empty($orphan_hosts)) { array_pop($nodes); } return network_general_map_configuration( $nodes, array_merge($relations, $orphan_hosts) ); }