-- -- (C) 2014-15 - ntop.org -- -- This file contains the description of all functions -- used to trigger host alerts local verbose = false local prefs = ntop.getPrefs() local info = ntop.getInfo() show_advanced_prefs_key = "ntopng.prefs.show_advanced_prefs" local function hasBridgeInterfaces() local curif = ifname local ifnames = interface.getIfNames() local found = false for _,ifname in pairs(ifnames) do interface.select(ifname) local ifstats = interface.getStats() if isBridgeInterface(ifstats) then found = true break end end interface.select(curif) return found end -- This table is used both to control access to the preferences and to filter preferences results menu_subpages = { {id="auth", label=i18n("prefs.user_authentication"), advanced=false, pro_only=true, disabled=false, entries={ multiple_ldap_authentication = { title = i18n("prefs.multiple_ldap_authentication_title"), description = i18n("prefs.multiple_ldap_authentication_description"), }, multiple_ldap_account_type = { title = i18n("prefs.multiple_ldap_account_type_title"), description = i18n("prefs.multiple_ldap_account_type_description"), }, ldap_server_address = { title = i18n("prefs.ldap_server_address_title"), description = i18n("prefs.ldap_server_address_description"), }, bind_dn = { title = i18n("prefs.bind_dn_title"), description = i18n("prefs.bind_dn_description"), }, bind_pwd = { title = i18n("prefs.bind_pwd_title"), description = i18n("prefs.bind_pwd_description"), }, search_path = { title = i18n("prefs.search_path_title"), description = i18n("prefs.search_path_description"), }, user_group = { title = i18n("prefs.user_group_title"), description = i18n("prefs.user_group_description"), }, admin_group = { title = i18n("prefs.admin_group_title"), description = i18n("prefs.admin_group_description"), }, toggle_ldap_anonymous_bind = { title = i18n("prefs.toggle_ldap_anonymous_bind_title"), description = i18n("prefs.toggle_ldap_anonymous_bind_description"), }, }}, {id="ifaces", label=i18n("prefs.network_interfaces"), advanced=true, pro_only=false, disabled=false, entries={ dynamic_iface_vlan_creation = { title = i18n("prefs.dynamic_iface_vlan_creation_title"), description = i18n("prefs.dynamic_iface_vlan_creation_description"), }, dynamic_flow_collection = { title = i18n("prefs.dynamic_flow_collection_title"), description = i18n("prefs.dynamic_flow_collection_description"), }, }}, {id="in_memory", label=i18n("prefs.cache_settings"), advanced=true, pro_only=false, disabled=false, entries={ local_host_max_idle = { title = i18n("prefs.local_host_max_idle_title"), description = i18n("prefs.local_host_max_idle_description"), }, non_local_host_max_idle = { title = i18n("prefs.non_local_host_max_idle_title"), description = i18n("prefs.non_local_host_max_idle_description"), }, flow_max_idle = { title = i18n("prefs.flow_max_idle_title"), description = i18n("prefs.flow_max_idle_description"), }, housekeeping_frequency = { title = i18n("prefs.housekeeping_frequency_title"), description = i18n("prefs.housekeeping_frequency_description"), }, toggle_local_host_cache_enabled = { title = i18n("prefs.toggle_local_host_cache_enabled_title"), description = i18n("prefs.toggle_local_host_cache_enabled_description"), }, toggle_active_local_host_cache_enabled = { title = i18n("prefs.toggle_active_local_host_cache_enabled_title"), description = i18n("prefs.toggle_active_local_host_cache_enabled_description"), }, active_local_host_cache_interval = { title = i18n("prefs.active_local_host_cache_interval_title"), description = i18n("prefs.active_local_host_cache_interval_description"), }, local_host_cache_duration = { title = i18n("prefs.local_host_cache_duration_title"), description = i18n("prefs.local_host_cache_duration_description"), }, }}, {id="on_disk_ts", label=i18n("prefs.data_retention"), advanced=false, pro_only=false, disabled=false, entries={ toggle_local = { title = i18n("prefs.toggle_local_title"), description = i18n("prefs.toggle_local_description"), }, toggle_local_ndpi = { title = i18n("prefs.toggle_local_ndpi_title"), description = i18n("prefs.toggle_local_ndpi_description"), }, toggle_local_activity = { title = i18n("prefs.toggle_local_activity_title"), description = i18n("prefs.toggle_local_activity_description"), }, toggle_flow_rrds = { title = i18n("prefs.toggle_flow_rrds_title"), description = i18n("prefs.toggle_flow_rrds_description"), }, toggle_pools_rrds = { title = i18n("prefs.toggle_pools_rrds_title"), description = i18n("prefs.toggle_pools_rrds_description"), }, toggle_asn_rrds = { title = i18n("prefs.toggle_asn_rrds_title"), description = i18n("prefs.toggle_asn_rrds_description"), }, toggle_tcp_flags_rrds = { title = i18n("prefs.toggle_tcp_flags_rrds_title"), description = i18n("prefs.toggle_tcp_flags_rrds_description"), }, toggle_tcp_retr_ooo_lost_rrds = { title = i18n("prefs.toggle_tcp_retr_ooo_lost_rrds_title"), description = i18n("prefs.toggle_tcp_retr_ooo_lost_rrds_description"), }, toggle_local_categorization = { title = i18n("prefs.toggle_local_categorization_title"), description = i18n("prefs.toggle_local_categorization_description"), }, minute_top_talkers_retention = { title = i18n("prefs.minute_top_talkers_retention_title"), description = i18n("prefs.minute_top_talkers_retention_description"), }, mysql_retention = { title = i18n("prefs.mysql_retention_title"), description = i18n("prefs.mysql_retention_description"), hidden = (prefs.is_dump_flows_to_mysql_enabled == false), } }}, {id="alerts", label=i18n("show_alerts.alerts"), advanced=false, pro_only=false, disabled=(prefs.has_cmdl_disable_alerts == true), entries={ disable_alerts_generation = { title = i18n("prefs.disable_alerts_generation_title"), description = i18n("prefs.disable_alerts_generation_description"), }, toggle_flow_alerts_iface = { title = i18n("prefs.toggle_flow_alerts_iface_title"), description = i18n("prefs.toggle_flow_alerts_iface_description"), }, toggle_alert_probing = { title = i18n("prefs.toggle_alert_probing_title"), description = i18n("prefs.toggle_alert_probing_description"), }, toggle_malware_probing = { title = i18n("prefs.toggle_malware_probing_title"), description = i18n("prefs.toggle_malware_probing_description", {url="https://rules.emergingthreats.net/fwrules/emerging-Block-IPs.txt"}), }, max_num_alerts_per_entity = { title = i18n("prefs.max_num_alerts_per_entity_title"), description = i18n("prefs.max_num_alerts_per_entity_description"), }, max_num_flow_alerts = { title = i18n("prefs.max_num_flow_alerts_title"), description = i18n("prefs.max_num_flow_alerts_description"), }, toggle_mysql_check_open_files_limit = { title = i18n("prefs.toggle_mysql_check_open_files_limit_title"), description = i18n("prefs.toggle_mysql_check_open_files_limit_description"), hidden = (prefs.is_dump_flows_to_mysql_enabled == false), } }}, {id="ext_alerts", label=i18n("prefs.external_alerts"), advanced=false, pro_only=false, disabled=alerts_disabled, entries={ toggle_alert_syslog = { title = i18n("prefs.toggle_alert_syslog_title"), description = i18n("prefs.toggle_alert_syslog_description"), }, toggle_slack_notification = { title = i18n("prefs.toggle_slack_notification_title", {url="http://www.slack.com"}), description = i18n("prefs.toggle_slack_notification_description"), }, slack_notification_severity_preference = { title = i18n("prefs.slack_notification_severity_preference_title", {url="http://www.slack.com"}), description = i18n("prefs.slack_notification_severity_preference_description"), }, sender_username = { title = i18n("prefs.sender_username_title"), description = i18n("prefs.sender_username_description"), }, slack_webhook = { title = i18n("prefs.slack_webhook_title"), description = i18n("prefs.slack_webhook_description"), }, toggle_alert_nagios = { title = i18n("prefs.toggle_alert_nagios_title"), description = i18n("prefs.toggle_alert_nagios_description"), }, nagios_nsca_host = { title = i18n("prefs.nagios_nsca_host_title"), description = i18n("prefs.nagios_nsca_host_description"), }, nagios_nsca_port = { title = i18n("prefs.nagios_nsca_port_title"), description = i18n("prefs.nagios_nsca_port_description"), }, nagios_send_nsca_executable = { title = i18n("prefs.nagios_send_nsca_executable_title"), description = i18n("prefs.nagios_send_nsca_executable_description"), }, nagios_send_nsca_config = { title = i18n("prefs.nagios_send_nsca_config_title"), description = i18n("prefs.nagios_send_nsca_config_description"), }, nagios_host_name = { title = i18n("prefs.nagios_host_name_title"), description = i18n("prefs.nagios_host_name_description"), }, nagios_service_name = { title = i18n("prefs.nagios_service_name_title"), description = i18n("prefs.nagios_service_name_description"), }, }}, {id="protocols", label=i18n("prefs.protocols"), advanced=false, pro_only=false, disabled=false, entries={ toggle_top_sites = { title = i18n("prefs.toggle_top_sites_title"), description = i18n("prefs.toggle_top_sites_description", {url="https://resources.sei.cmu.edu/asset_files/Presentation/2010_017_001_49763.pdf"}), }, }}, {id="logging", label=i18n("prefs.logging"), advanced=false, pro_only=false, disabled=(prefs.has_cmdl_trace_lvl == true), entries={ toggle_logging_level = { title = i18n("prefs.toggle_logging_level_title"), description = i18n("prefs.toggle_logging_level_description"), }, toggle_access_log = { title = i18n("prefs.toggle_access_log_title"), description = i18n("prefs.toggle_access_log_description"), }, }}, {id="flow_db_dump", label=i18n("prefs.flow_database_dump"), advanced=true, pro_only=false, disabled=(prefs.is_dump_flows_enabled == false), entries={ toggle_flow_db_dump_export = { title = i18n("prefs.toggle_flow_db_dump_export_title"), description = i18n("prefs.toggle_flow_db_dump_export_description"), }, max_num_packets_per_tiny_flow = { title = i18n("prefs.max_num_packets_per_tiny_flow_title"), description = i18n("prefs.max_num_packets_per_tiny_flow_description"), }, max_num_bytes_per_tiny_flow = { title = i18n("prefs.max_num_bytes_per_tiny_flow_title"), description = i18n("prefs.max_num_bytes_per_tiny_flow_description"), }, }}, {id="snmp", label=i18n("prefs.snmp"), advanced=true, pro_only=true, disabled=false, entries={ toggle_snmp_rrds = { title = i18n("prefs.toggle_snmp_rrds_title"), description = i18n("prefs.toggle_snmp_rrds_description"), }, default_snmp_community = { title = i18n("prefs.default_snmp_community_title"), description = i18n("prefs.default_snmp_community_description"), }, }}, {id="nbox", label=i18n("prefs.nbox_integration"), advanced=true, pro_only=true, disabled=false, entries={ toggle_nbox_integration = { title = i18n("prefs.toggle_nbox_integration_title"), description = i18n("prefs.toggle_nbox_integration_description"), }, nbox_user = { title = i18n("prefs.nbox_user_title"), description = i18n("prefs.nbox_user_description"), }, nbox_password = { title = i18n("prefs.nbox_password_title"), description = i18n("prefs.nbox_password_description"), }, }}, {id="misc", label=i18n("prefs.misc"), advanced=false, pro_only=false, disabled=false, entries={ toggle_autologout = { title = i18n("prefs.toggle_autologout_title"), description = i18n("prefs.toggle_autologout_description"), }, google_apis_browser_key = { title = i18n("prefs.google_apis_browser_key_title"), description = i18n("prefs.google_apis_browser_key_description", {url="https://googlegeodevelopers.blogspot.it/2016-17/06/building-for-scale-updates-to-google.html"}), }, toggle_thpt_content = { title = i18n("prefs.toggle_thpt_content_title"), description = i18n("prefs.toggle_thpt_content_description"), }, toggle_host_mask = { title = i18n("prefs.toggle_host_mask_title"), description = i18n("prefs.toggle_host_mask_description"), } }}, {id="bridging", label=i18n("prefs.traffic_bridging"), advanced=false, pro_only=true, enterprise_only=true, disabled=(not hasBridgeInterfaces()), entries={ toggle_shaping_directions = { title = i18n("prefs.toggle_shaping_directions_title"), description = i18n("prefs.toggle_shaping_directions_description"), }, toggle_captive_portal = { title = i18n("prefs.toggle_captive_portal_title"), description = i18n("prefs.toggle_captive_portal_description"), }, }}, } function isSubpageAvailable(subpage, show_advanced_prefs) if show_advanced_prefs == nil then show_advanced_prefs = toboolean(ntop.getPref(show_advanced_prefs_key)) end if (subpage.disabled) or ((subpage.advanced) and (not show_advanced_prefs)) or ((subpage.pro_only) and (not ntop.isPro())) or ((subpage.enterprise_only) and (not info["version.enterprise_edition"])) then return false end return true end -- notify ntopng upon preference changes function notifyNtopng(key) if key == nil then return end -- notify runtime ntopng configuration changes if string.starts(key, 'nagios') then if verbose then io.write('notifying ntopng upon nagios pref change\n') end ntop.reloadNagiosConfig() elseif string.starts(key, 'toggle_logging_level') then if verbose then io.write('notifying ntopng upon logging level pref change\n') end ntop.setLoggingLevel(value) end end -- ############################################ local options_script_loaded = false local options_ctr = 0 function prefsResolutionButtons(fmt, value, fixed_id) local ctrl_id if fixed_id ~= nil then ctrl_id = fixed_id else ctrl_id = "options_group_" .. options_ctr options_ctr = options_ctr + 1 end local res = makeResolutionButtons(FMT_TO_DATA_TIME, ctrl_id, fmt, value, {classes={"pull-right"}}) print(res.html) print("") return res.value end -- ############################################ -- Runtime preference function prefsInputFieldPrefs(label, comment, prekey, key, default_value, _input_type, showEnabled, disableAutocomplete, allowURLs, extra) extra = extra or {} if(string.ends(prekey, ".")) then k = prekey..key else k = prekey.."."..key end if(_POST[key] ~= nil) then v_s = _POST[key] v = tonumber(v_s) v_cache = ntop.getPref(k) value = v_cache if ((v_cache==nil) or (v ~= v_cache)) then if(v ~= nil and (v > 0) and (v <= 86400)) then ntop.setPref(k, tostring(v)) value = v elseif (v_s ~= nil) then if(allowURLs) then v_s = string.gsub(v_s, "ldaps:__", "ldaps://") v_s = string.gsub(v_s, "ldap:__", "ldap://") v_s = string.gsub(v_s, "http:__", "http://") v_s = string.gsub(v_s, "https:__", "https://") end ntop.setPref(k, v_s) value = v_s end -- least but not last we asynchronously notify the runtime ntopng instance for changes notifyNtopng(key) end else v_s = ntop.getPref(k) value = v_s if((v_s==nil) or (v_s=="")) then ntop.setPref(k, tostring(default_value)) value = default_value notifyNtopng(key) end end if ((showEnabled == nil) or (showEnabled == true)) then showEnabled = "table-row" else showEnabled = "none" end local attributes = {} if extra.min ~= nil then if extra.tformat ~= nil then attributes["data-min"] = extra.min else attributes["min"] = extra.min end end if extra.max ~= nil then if extra.tformat ~= nil then attributes["data-max"] = extra.max else attributes["max"] = extra.max end end if extra.disabled == true then attributes["disabled"] = "disabled" end if (_input_type == "number") then attributes["required"] = "required" end local input_type = "text" if _input_type ~= nil then input_type = _input_type end print(''..label..'

'..comment..'') local style = {} style["text-align"] = "right" style["margin-bottom"] = "0.5em" print [[
]] if extra.tformat ~= nil then value = prefsResolutionButtons(extra.tformat, value) end if extra.width == nil then if _input_type == "number" then style["width"] = "8em" else style["width"] = "20em" end style["margin-left"] = "auto" else style["width"] = "15em" end style["margin-left"] = "auto" style = table.merge(style, extra.style) attributes = table.merge(attributes, extra.attributes) print[[
]] end function toggleTableButton(label, comment, on_label, on_value, on_color , off_label, off_value, off_color, submit_field, redis_key, disabled) if(_POST[submit_field] ~= nil) then ntop.setPref(redis_key, _POST[submit_field]) value = _POST[submit_field] notifyNtopng(submit_field) else value = ntop.getPref(redis_key) end if (disabled == true) then disabled = 'disabled = ""' else disabled = "" end -- Read it anyway to if(value == off_value) then rev_value = on_value on_active = "btn-default" off_active = "btn-"..off_color.." active" else rev_value = off_value on_active = "btn-"..on_color.." active" off_active = "btn-default" end if(label ~= "") then print(''..label..'

'..comment..'\n') end print('

\n
') print('') print('
\n') print('\n') print('\n') print('
\n') if(label ~= "") then print('') end return(value) end function toggleTableButtonPrefs(label, comment, on_label, on_value, on_color , off_label, off_value, off_color, submit_field, redis_key, default_value, disabled, elementToSwitch, hideOn, showElement) value = ntop.getPref(redis_key) if(_POST[submit_field] ~= nil) then if ( (value == nil) or (value ~= _POST[submit_field])) then ntop.setPref(redis_key, _POST[submit_field]) value = _POST[submit_field] notifyNtopng(submit_field) end else if ((value == nil) or (value == "")) then if (default_value ~= nil) then value = default_value else value = off_value end ntop.setPref(redis_key, value) notifyNtopng(submit_field) end end if (disabled == true) then disabled = 'disabled = ""' else disabled = "" end -- Read it anyway to if(value == off_value) then on_active = "btn-default" off_active = "btn-"..off_color.." active" else value = on_value on_active = "btn-"..on_color.." active" off_active = "btn-default" end local objRow = "" if ((showElement ~= nil) and (showElement == false)) then objRow = " style=\"display:none\"" else objRow = " style=\"display:table-row\"" end if(label ~= "") then print(''..label..'

'..comment..'\n') end print('

') print('') print('
\n') print('\n') if(label ~= "") then print('') end print('\n') print('\n') return(value) end function multipleTableButtonPrefs(label, comment, array_labels, array_values, default_value, selected_color, submit_field, redis_key, disabled, elementToSwitch, showElementArray, javascriptAfterSwitch, showElement) if(_POST[submit_field] ~= nil) then ntop.setPref(redis_key, _POST[submit_field]) value = _POST[submit_field] notifyNtopng(submit_field) else value = ntop.getPref(redis_key) if(value == "") then if(default_value ~= nil) then ntop.setPref(redis_key, default_value) value = default_value end end end if (disabled == true) then disabled = 'disabled = ""' else disabled = "" end local objRow = "" if ((showElement ~= nil) and (showElement == false)) then objRow = " style=\"display:none\"" else objRow = " style=\"display:table-row\"" end if(value ~= nil) then if(label ~= "") then print(''..label..'

'..comment..'\n') end print('

') for nameCount = 1, #array_labels do local type_button = "btn-default" if(value == array_values[nameCount]) then local color if type(selected_color) == "table" then color = selected_color[nameCount] else color = selected_color end type_button = "btn-"..color.." active" end print('\n') end print('
\n') print('\n') print('\n') if(label ~= "") then print('') end end return(value) end function loggingSelector(label, comment, submit_field, redis_key) prefs = ntop.getPrefs() if prefs.has_cmdl_trace_lvl then return end if(_POST[submit_field] ~= nil) then ntop.setCache(redis_key, _POST[submit_field]) value = _POST[submit_field] notifyNtopng(submit_field, _POST[submit_field]) else value = ntop.getCache(redis_key) end if value == "" or value == nil then value = "normal" end local logging_values = {"trace", "debug", "info", "normal", "warning", "error"} local color_map = {"default", "success", "info", "primary", "warning", "danger"} local logging_keys = {} local color = "default" for i,v in ipairs(logging_values) do logging_keys[i] = firstToUpper(v) end multipleTableButtonPrefs("Log level", "Choose the runtime logging level.", logging_keys, logging_values, value, color_map, submit_field, redis_key) return(value) end