-- -- (C) 2013-16 - ntop.org -- dirs = ntop.getDirs() package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path if ( (dirs.scriptdir ~= nil) and (dirs.scriptdir ~= "")) then package.path = dirs.scriptdir .. "/lua/modules/?.lua;" .. package.path end require "lua_utils" require "prefs_utils" if (ntop.isPro()) then package.path = dirs.installdir .. "/scripts/lua/pro/?.lua;" .. package.path require "report_utils" end sendHTTPHeader('text/html; charset=iso-8859-1') if(haveAdminPrivileges()) then ntop.dumpFile(dirs.installdir .. "/httpdocs/inc/header.inc") active_page = "admin" dofile(dirs.installdir .. "/scripts/lua/inc/menu.lua") prefs = ntop.getPrefs() print [[

Runtime Preferences

]] subpage_active = _GET["subpage_active"] report_active = "" in_memory_active = "" on_disk_rrds_active = "" on_disk_dbs_active = "" nbox_active = "" alerts_active = "" users_active = "" logging_active = "" if (subpage_active == nil or subpage_active == "") then subpage_active = "users" end if (subpage_active == "report") then report_active = "active" end if (subpage_active == "in_memory") then in_memory_active = "active" end if (subpage_active == "on_disk_rrds") then on_disk_rrds_active = "active" end if (subpage_active == "on_disk_dbs") then on_disk_dbs_active = "active" end if (subpage_active == "nbox") then nbox_active = "active" end if (subpage_active == "alerts") then if not prefs.has_cmdl_disable_alerts then alerts_active = "active" else report_active = "active" -- default end end if (subpage_active == "users") then users_active = "active" end if (subpage_active == "logging") then if not prefs.has_cmdl_trace_lvl then logging_active = "active" else -- cannot change logging level when it has been specified from the command line report_active = "active" -- default end end -- ================================================================================ function printReportVisualization() print('
') print('\n') print('') print('') toggleTableButtonPrefs("Throughput Unit", "Select the throughput unit to be displayed in traffic reports.", "Bytes", "bps", "primary","Packets", "pps", "primary","toggle_thpt_content", "ntopng.prefs.thpt_content", "bps") print('') print('
Report Visualization
') print [[
]] end -- ================================================================================ function printTopTalkers() print('
') print('\n') print('') print('') --default value minute_top_talkers_retention = 365 prefsInputFieldPrefs("Data Retention", "Duration in days of minute top talkers data retention. Default: 365 days", "ntopng.prefs.", "minute_top_talkers_retention", minute_top_talkers_retention) print('') print('
Top Talkers Storage
') print [[
]] end -- ================================================================================ function printStatsDatabases() print('
') print('\n') print('') print('') mysql_retention = 30 prefsInputFieldPrefs("Data Retention", "Duration in days of data retention in the MySQL database. Default: 30 days", "ntopng.prefs.", "mysql_retention", mysql_retention) print('
MySQL Database
') print('') print('') --default value minute_top_talkers_retention = 365 prefsInputFieldPrefs("Data Retention", "Duration in days of minute top talkers data retention. Default: 365 days", "ntopng.prefs.", "minute_top_talkers_retention", minute_top_talkers_retention) print('') print('
Top Talkers Storage
') print [[
]] end -- ================================================================================ function printAlerts() if prefs.has_cmdl_disable_alerts then return end print('
') print('\n') print('') print('') toggleTableButtonPrefs("Enable Alerts", "Toggle the overall generation of alerts.", "On", "0", "success", -- On means alerts enabled and thus disable_alerts_generation == 0 "Off", "1", "danger", -- Off for enabled alerts implies 1 for disable_alerts_generation "disable_alerts_generation", "ntopng.prefs.disable_alerts_generation", "0") if ntop.getPrefs().are_alerts_enabled == true then showElements = true else showElements = false end prefsInputFieldPrefs("Maximum Number of Alerts per Entity", "The maximum number of alerts per alarmable entity. Alarmable entities are hosts, networks, interfaces and flows. ".. "Once the maximum number of entity alerts is reached, new alerts raised by the same entities will be discarded. ".. "Default: 1024.", "ntopng.prefs.", "max_num_alerts_per_entity", prefs.max_num_alerts_per_entity, nil, showElements) toggleTableButtonPrefs("Enable Probing Alerts", "Enable alerts generated when probing attempts are detected.", "On", "1", "success", "Off","0", "danger", "toggle_alert_probing", "ntopng.prefs.probing_alerts", "1", showElements == false) toggleTableButtonPrefs("Enable Hosts Malware Blacklists", "Enable alerts generated by traffic sent/received by malware-marked hosts.", "On", "enabled", "success", "Off","disabled", "danger", "toggle_malware_probing", "ntopng.prefs.host_blacklist", "1", showElements == false) toggleTableButtonPrefs("Alerts On Syslog", "Enable alerts logging on system syslog.", "On", "1", "success", "Off", "0", "danger", "toggle_alert_syslog", "ntopng.prefs.alerts_syslog", "1", showElements == false) if (ntop.isPro()) then print('') local elementToSwitch = {"nagios_nsca_host","nagios_nsca_port","nagios_send_nsca_executable","nagios_send_nsca_config","nagios_host_name","nagios_service_name"} toggleTableButtonPrefs("Alerts To Nagios", "Enable sending ntopng alerts to Nagios NSCA (Nagios Service Check Acceptor).", "On", "1", "success", "Off", "0", "danger", "toggle_alert_nagios", "ntopng.prefs.alerts_nagios", "0", showElements, elementToSwitch) if ntop.getPref("ntopng.prefs.alerts_nagios") == "1" then showElements = true else showElements = false end prefsInputFieldPrefs("Nagios NSCA Host", "Address of the host where the Nagios NSCA daemon is running. Default: localhost.", "ntopng.prefs.", "nagios_nsca_host", prefs.nagios_nsca_host, nil, showElements) prefsInputFieldPrefs("Nagios NSCA Port", "Port where the Nagios daemon's NSCA is listening. Default: 5667.", "ntopng.prefs.", "nagios_nsca_port", prefs.nagios_nsca_port, nil, showElements) prefsInputFieldPrefs("Nagios send_nsca executable", "Absolute path to the Nagios NSCA send_nsca utility. Default: /usr/local/nagios/bin/send_nsca", "ntopng.prefs.", "nagios_send_nsca_executable", prefs.nagios_send_nsca_executable, nil, showElements) prefsInputFieldPrefs("Nagios send_nsca configuration", "Absolute path to the Nagios NSCA send_nsca utility configuration file. Default: /usr/local/nagios/etc/send_nsca.cfg", "ntopng.prefs.", "nagios_send_nsca_config", prefs.nagios_send_nsca_conf, nil, showElements) prefsInputFieldPrefs("Nagios host_name", "The host_name exactly as specified in Nagios host definition for the ntopng host. Default: ntopng-host", "ntopng.prefs.", "nagios_host_name", prefs.nagios_host_name, nil, showElements) prefsInputFieldPrefs("Nagios service_description", "The service description exactly as specified in Nagios passive service definition for the ntopng host. Default: NtopngAlert", "ntopng.prefs.", "nagios_service_name", prefs.nagios_service_name, nil, showElements) end print('') print('
Alerts
Nagios Integration
') print [[
]] end -- ================================================================================ function printNbox() print('
') print('\n') print('') print('') local elementToSwitch = {"nbox_user","nbox_password"} toggleTableButtonPrefs("Enable nBox Support", "Enable sending ntopng requests (e.g., to download pcap files) to an nBox. Pcap requests are issued from the historical data browser when browsing 'Talkers' and 'Protocols'. Each request carry information on the search criteria generated by the user when drilling-down historical data. Requests are queued and pcaps become available for download from a dedicated 'Pcaps' tab once generated.", "On", "1", "success", "Off", "0", "danger", "toggle_nbox_integration", "ntopng.prefs.nbox_integration", "0", nil, elementToSwitch) if ntop.getPref("ntopng.prefs.nbox_integration") == "1" then showElements = true else showElements = false end prefsInputFieldPrefs("nBox User", "User that has privileges to access the nBox. Default: nbox", "ntopng.prefs.", "nbox_user", "nbox", nil, showElements) prefsInputFieldPrefs("nBox Password", "Password associated to the nBox user. Default: nbox", "ntopng.prefs.", "nbox_password", "nbox", "password", showElements) print('') print('
nBox Integration
') print [[
]] end -- ================================================================================ function printUsers() print('
') print('\n') print('') print('') if prefs.is_autologout_enabled == true then toggleTableButtonPrefs("Auto Logout", "Toggle the automatic logout of web interface users with expired sessions.", "On", "1", "success", "Off", "0", "danger", "toggle_autologout", "ntopng.prefs.is_autologon_enabled", "1") end prefsInputFieldPrefs("Google APIs Browser Key", "Graphical hosts geomaps are based on Google Maps APIs. Google recently changed Maps API access policies ".. "and now requires a browser API key to be sumbitted for every request. Detailed information on how to obtain an API key ".. "can be found here. ".. "Once obtained, the API key can be placed in this field." , "ntopng.prefs.", "google_apis_browser_key", "") if ntop.isPro() then print('') local labels = {"Local","LDAP","LDAP/Local"} local values = {"local","ldap","ldap_local"} local elementToSwitch = {"row_multiple_ldap_account_type", "row_toggle_ldap_anonymous_bind","server","bind_dn", "bind_pwd", "search_path", "user_group", "admin_group"} local showElementArray = {false, true, true} local javascriptAfterSwitch = ""; javascriptAfterSwitch = javascriptAfterSwitch.." if ($(\"#id-toggle-multiple_ldap_authentication\").val() != \"local\" ) {\n" javascriptAfterSwitch = javascriptAfterSwitch.." if ($(\"#toggle_ldap_anonymous_bind_input\").val() == \"0\") {\n" javascriptAfterSwitch = javascriptAfterSwitch.." $(\"#bind_dn\").css(\"display\",\"table-row\");\n" javascriptAfterSwitch = javascriptAfterSwitch.." $(\"#bind_pwd\").css(\"display\",\"table-row\");\n" javascriptAfterSwitch = javascriptAfterSwitch.." } else {\n" javascriptAfterSwitch = javascriptAfterSwitch.." $(\"#bind_dn\").css(\"display\",\"none\");\n" javascriptAfterSwitch = javascriptAfterSwitch.." $(\"#bind_pwd\").css(\"display\",\"none\");\n" javascriptAfterSwitch = javascriptAfterSwitch.." }\n" javascriptAfterSwitch = javascriptAfterSwitch.." }\n" local retVal = multipleTableButtonPrefs("Authentication Method", "Local (Local only), LDAP (LDAP server only), LDAP/Local (Authenticate with LDAP server, if fails it uses local authentication).", labels, values, "local", "primary", "multiple_ldap_authentication", "ntopng.prefs.auth_type", nil, elementToSwitch, showElementArray, javascriptAfterSwitch) local showElements = true; if ntop.getPref("ntopng.prefs.auth_type") == "local" then showElements = false end local labels_account = {"Posix","sAMAccount"} local values_account = {"posix","samaccount"} multipleTableButtonPrefs("LDAP Accounts Type", "Choose your account type", labels_account, values_account, "posix", "primary", "multiple_ldap_account_type", "ntopng.prefs.ldap.account_type", nil, nil, nil, nil, showElements) prefsInputFieldPrefs("LDAP Server Address", "IP address and port of LDAP server (e.g. ldaps://localhost:636). Default: \"ldap://localhost:389\".", "ntopng.prefs.ldap", "server", "ldap://localhost:389", nil, showElements) local elementToSwitchBind = {"bind_dn","bind_pwd"} toggleTableButtonPrefs("LDAP Anonymous Binding","Enable anonymous binding.","On", "1", "success", "Off", "0", "danger", "toggle_ldap_anonymous_bind", "ntopng.prefs.ldap.anonymous_bind", "0", nil, elementToSwitchBind, true, showElements) local showEnabledAnonymousBind = false if ntop.getPref("ntopng.prefs.ldap.anonymous_bind") == "0" then showEnabledAnonymousBind = true end local showElementsBind = showElements if showElements == true then showElementsBind = showEnabledAnonymousBind end prefsInputFieldPrefs("LDAP Bind DN", "Bind Distinguished Name of LDAP server. Example: \"CN=ntop_users,DC=ntop,DC=org,DC=local\".", "ntopng.prefs.ldap", "bind_dn", "", nil, showElementsBind, true) prefsInputFieldPrefs("LDAP Bind Authentication Password", "Bind password used for authenticating with the LDAP server.", "ntopng.prefs.ldap", "bind_pwd", "", "password", showElementsBind, true) prefsInputFieldPrefs("LDAP Search Path", "Root path used to search the users.", "ntopng.prefs.ldap", "search_path", "", "text", showElements) prefsInputFieldPrefs("LDAP User Group", "Group name to which user has to belong in order to authenticate as unprivileged user.", "ntopng.prefs.ldap", "user_group", "", "text", showElements) prefsInputFieldPrefs("LDAP Admin Group", "Group name to which user has to belong in order to authenticate as an administrator.", "ntopng.prefs.ldap", "admin_group", "", "text", showElements) end print('') print('
Web User Interface
Authentication
') print [[
]] end -- ================================================================================ function printInMemory() print('
') print('\n') print('') print('') prefsInputFieldPrefs("Local Host Idle Timeout", "Inactivity time after which a local host is considered idle (sec). ".. "Idle local hosts are dumped to a cache so their counters can be restored in case they become active again. ".. "Counters include, but are not limited to, packets and bytes total and per Layer-7 application. ".. "Default: 300.", "ntopng.prefs.","local_host_max_idle", prefs.local_host_max_idle) prefsInputFieldPrefs("Remote Host Idle Timeout", "Inactivity time after which a remote host is considered idle (sec). Default: 60.", "ntopng.prefs.", "non_local_host_max_idle", prefs.non_local_host_max_idle) prefsInputFieldPrefs("Flow Idle Timeout", "Inactivity time after which a flow is considered idle (sec). Default: 60.", "ntopng.prefs.", "flow_max_idle", prefs.flow_max_idle) print('') toggleTableButtonPrefs("Idle Local Hosts Cache", "Toggle the creation of cache entries for idle local hosts. ".. "Cached local hosts counters are restored automatically to their previous values ".. " upon detection of additional host traffic.", "On", "1", "success", "Off", "0", "danger", "toggle_local_host_cache_enabled", "ntopng.prefs.is_local_host_cache_enabled", "1") toggleTableButtonPrefs("Active Local Hosts Cache", "Toggle the hourly creation of cache entries for active local hosts. ".. "Caching active local hosts on an hourly basis can be useful to protect host counters against ".. "failures (e.g., power losses). This is particularly important for local hosts that seldomly go idle ".. "as it guarantees that their counters will be cached at least once per hour. ", "On", "1", "success", "Off", "0", "danger", "toggle_active_local_host_cache_enabled", "ntopng.prefs.is_active_local_host_cache_enabled", "0") prefsInputFieldPrefs("Local Hosts Cache Duration", "Time after which a cached local host is deleted from the cache (sec). ".. "Default: 3600.", "ntopng.prefs.","local_host_cache_duration", prefs.local_host_cache_duration) print('') prefsInputFieldPrefs("Update frequency in seconds", "Some host statistics such as throughputs are updated periodically. ".. "This value regulates how often ntopng will update these statistics. ".. "Larger values are less computationally intensive and tend to average out minor variations. ".. "Smaller values are more computationally intensive and tend to highlight minor variations. ".. "Values in the order of few secods are safe. " .. "Default: 5 seconds.", "ntopng.prefs.", "housekeeping_frequency", prefs.housekeeping_frequency) print('') print('
Idle Timeout Settings
Local Hosts Cache Settings
Hosts Statistics Update Frequency
') print [[
]] end -- ================================================================================ function printStatsRrds() print('
') print('\n') print('') print('') toggleTableButtonPrefs("Traffic Timeseries", "Toggle the creation of traffic timeseries for local hosts and networks. Turn it off to save storage space.", "On", "1", "success", "Off", "0", "danger", "toggle_local", "ntopng.prefs.host_rrd_creation", "1") toggleTableButtonPrefs("Layer-7 Application Timeseries", "Toggle the creation of nDPI timeseries for local hosts and defined networks. Enable their creation allows you ".. "to keep application protocol statistics at the cost of using more disk space.", "On", "1", "success", "Off", "0", "danger", "toggle_local_ndpi", "ntopng.prefs.host_ndpi_rrd_creation", "0") local toggle_local_activity = "toggle_local_activity" local activityPrefsToSwitch = {"local_activity_prefs", "host_activity_rrd_raw_hours", "id_input_host_activity_rrd_raw_hours", "host_activity_rrd_1h_days", "id_input_host_activity_rrd_1h_days", "host_activity_rrd_1d_days", "id_input_host_activity_rrd_1d_days"} if prefs.is_flow_activity_enabled then toggleTableButtonPrefs("Activities Timeseries", "Toggle the creation of activities timeseries for local hosts and networks. Turn it off to save storage space.", "On", "1", "success", "Off", "0", "danger", toggle_local_activity, "ntopng.prefs.host_activity_rrd_creation", "0", false, activityPrefsToSwitch) end local info = ntop.getInfo() toggleTableButtonPrefs("Flow Devices Timeseries", "Toggle the creation of bytes timeseries for each port of the sFlow/NetFlow devices. For each device port" .. " will be created an RRD with ingress/egress bytes.", "On", "1", "success", "Off", "0", "danger", "toggle_flow_rrds", "ntopng.prefs.flow_devices_rrd_creation", "0", not info["version.enterprise_edition"]) toggleTableButtonPrefs("Category Timeseries", "Toggle the creation of Category timeseries for local hosts and defined networks. Enabling their creation allows you ".. "to keep persistent traffic category statistics (e.g., social networks, news) at the cost of using more disk space.
".. "Creation is only possible if the ntopng instance has been launched with option -k flashstart:<user>:<password>.", "On", "1", "success", "Off", "0", "danger", "toggle_local_categorization", "ntopng.prefs.host_categories_rrd_creation", "0", not prefs.is_categorization_enabled) print('
Local Hosts and Networks Timeseries
') print('') print('') prefsInputFieldPrefs("Days for raw stats", "Number of days for which raw stats are kept. Default: 1.", "ntopng.prefs.", "intf_rrd_raw_days", prefs.intf_rrd_raw_days) prefsInputFieldPrefs("Days for 1 min resolution stats", "Number of days for which stats are kept in 1 min resolution. Default: 30.", "ntopng.prefs.", "intf_rrd_1min_days", prefs.intf_rrd_1min_days) prefsInputFieldPrefs("Days for 1 hour resolution stats", "Number of days for which stats are kept in 1 hour resolution. Default: 100.", "ntopng.prefs.", "intf_rrd_1h_days", prefs.intf_rrd_1h_days) prefsInputFieldPrefs("Days for 1 day resolution stats", "Number of days for which stats are kept in 1 day resolution. Default: 365.", "ntopng.prefs.", "intf_rrd_1d_days", prefs.intf_rrd_1d_days) print('') prefsInputFieldPrefs("Days for raw stats", "Number of days for which raw stats are kept. Default: 1.", "ntopng.prefs.", "other_rrd_raw_days", prefs.other_rrd_raw_days) --prefsInputFieldPrefs("Days for 1 min resolution stats", "Number of days for which stats are kept in 1 min resolution. Default: 30.", "ntopng.prefs.", "other_rrd_1min_days", prefs.other_rrd_1min_days) prefsInputFieldPrefs("Days for 1 hour resolution stats", "Number of days for which stats are kept in 1 hour resolution. Default: 100.", "ntopng.prefs.", "other_rrd_1h_days", prefs.other_rrd_1h_days) prefsInputFieldPrefs("Days for 1 day resolution stats", "Number of days for which stats are kept in 1 day resolution. Default: 365.", "ntopng.prefs.", "other_rrd_1d_days", prefs.other_rrd_1d_days) -- Only shown when toggle_local_activity switch is on if prefs.is_flow_activity_enabled then print('') prefsInputFieldPrefs("Hours for raw stats", "Number of hours for which raw stats are kept. Default: 48.", "ntopng.prefs.", "host_activity_rrd_raw_hours", prefs.host_activity_rrd_raw_hours) prefsInputFieldPrefs("Days for 1 hour resolution stats", "Number of days for which stats are kept in 1 hour resolution. Default: 15.", "ntopng.prefs.", "host_activity_rrd_1h_days", prefs.host_activity_rrd_1h_days) prefsInputFieldPrefs("Days for 1 day resolution stats", "Number of days for which stats are kept in 1 day resolution. Default: 90.", "ntopng.prefs.", "host_activity_rrd_1d_days", prefs.host_activity_rrd_1d_days) end print('') print('
Network Interface Timeseries
Protocol/Networks Timeseries
Local Activity Timeseries
') print [[
]] end -- ================================================================================ function printLogging() if prefs.has_cmdl_trace_lvl then return end print('
') print('\n') print('') print('') loggingSelector("Log level", "Choose the runtime logging level.", "toggle_logging_level", "ntopng.prefs.logging_level") print('') print [[
Logging
]] end print[[
Users In-Memory Data On-Disk Timeseries On-Disk Databases]] if not prefs.has_cmdl_disable_alerts then print[[Alerts]] end print[[Units of Measurement]] if not prefs.has_cmdl_trace_lvl then print [[Log Level ]] end if (ntop.isPro()) then print [[nBox Integration ]] end print[[
]] if (subpage_active == "report") then printReportVisualization() end if (subpage_active == "in_memory") then printInMemory() end if (subpage_active == "on_disk_rrds") then printStatsRrds() end if (subpage_active == "on_disk_dbs") then printStatsDatabases() end if (subpage_active == "alerts") then if not prefs.has_cmdl_disable_alerts then printAlerts() else printReportVisualization() end end if (subpage_active == "nbox") then if (ntop.isPro()) then printNbox() end end if (subpage_active == "users") then printUsers() end if (subpage_active == "logging") then if not prefs.has_cmdl_trace_lvl then printLogging() else printReportVisualization() end end print[[
]] dofile(dirs.installdir .. "/scripts/lua/inc/footer.lua") print([[]]) end