-- -- (C) 2013-20 - ntop.org -- local dirs = ntop.getDirs() local info = ntop.getInfo() package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path local plugins_utils = require("plugins_utils") local template_utils = require("template_utils") local recording_utils = require("recording_utils") local page_utils = {} local is_nedge = ntop.isnEdge() -- ################################# local active_section = nil local active_entry = nil -- ################################# page_utils.menu_sections = { dashboard = {key = "dashboard", i18n_title = "index_page.dashboard", icon = "fas fa-tachometer-alt"}, alerts = {key = "alerts", i18n_title = "details.alerts", icon = "fas fa-exclamation-triangle"}, flows = {key = "flows", i18n_title = "flows", icon = "fas fa-stream"}, hosts = {key = "hosts", i18n_title = "hosts", icon = "fas fa-laptop"}, exporters = {key = "exporters", i18n_title = "flow_devices.exporters", icon = "fas fa-file-export", zmq_only = true --[[ only for non-packet ZMQ interfaces --]] }, if_stats = {key = "if_stats", i18n_title = "interface", icon = "fas fa-ethernet"}, system_stats = {key = "system_stats", i18n_title = "system", icon = "fas fa-desktop"}, admin = {key = "admin", i18n_title = "settings", icon = "fas fa-cog"}, dev = {key = "dev", i18n_title = "developer", icon = "fas fa-code"}, about = {key = "about", i18n_title = "help", icon = "fas fa-life-ring"}, health = {key = "system_health", i18n_title = "health", icon = "fas fa-laptop-medical"}, pollers = {key = "pollers", i18n_title = "pollers", icon = "fas fa-heartbeat"}, tools = {key = "tools", i18n_title = "tools", icon = "fas fa-cogs"}, pools = {key = "pools", i18n_title = "pools.pools", icon = "fas fa-users"}, notifications = {key = "notifications", i18n_title = "endpoint_notifications.notifications", icon = "fas fa-bell"}, -- nEdge views = {key = "hosts", i18n_title = "views", icon = "fas fa-bars"}, } -- ################################# -- visible_iface: this flag is true when the page belong to interface view -- visible_system: this flags is true when the page belong to system view -- if both flags are true it means the pages are shared between views -- help_link: this variable contains the contextual link to the documentation page_utils.menu_entries = { -- Dashboard traffic_dashboard = {key = "traffic_dashboard", i18n_title = "dashboard.traffic_dashboard", section = "dashboard", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/dashboard.html"}, network_discovery = {key = "network_discovery", i18n_title = "discover.network_discovery", section = "dashboard", visible_iface = true}, traffic_report = {key = "traffic_report", i18n_title = "report.traffic_report", section = "dashboard", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/report.html"}, db_explorer = {key = "db_explorer", i18n_title = "db_explorer.historical_data_explorer", section = "dashboard", visible_iface = true}, -- Alerts detected_alerts = {key = "detected_alerts", i18n_title = "show_alerts.detected_alerts", section = "alerts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/alerts.html"}, alerts_dashboard = {key = "alerts_dashboard", i18n_title = "alerts_dashboard.alerts_dashboard", section = "alerts", visible_iface = true}, flow_alerts_explorer = {key = "flow_alerts_explorer", i18n_title = "flow_alerts_explorer.label", section = "alerts", visible_iface = true}, -- Flows flows = {key = "flows", i18n_title = "flows", section = "flows", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/flows.html"}, flow_details = {key = "flow_details", i18n_title = "flow_details.flow_details", section = "flows", visible_iface = true}, -- Hosts hosts = {key = "hosts", i18n_title = "hosts", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html#"}, devices = {key = "devices", i18n_title = "layer_2", section = "hosts", visible_iface = true}, networks = {key = "networks", i18n_title = "networks", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#networks"}, vlans = {key = "vlans", i18n_title = "vlan_stats.vlans", section = "hosts", visible_iface = true}, host_pools = {key = "host_pools", i18n_title = "host_pools.host_pools", section = "hosts", visible_iface = true}, autonomous_systems = {key = "autonomous_systems", i18n_title = "as_stats.autonomous_systems", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#autonomous-systems"}, countries = {key = "countries", i18n_title = "countries", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#countries"}, operating_systems = {key = "operating_systems", i18n_title = "operating_systems", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#operating-systems"}, http_servers = {key = "http_servers", i18n_title = "http_servers_stats.http_servers", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#http-servers-local"}, top_hosts = {key = "top_hosts", i18n_title = "processes_stats.top_hosts", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#top-hosts-local"}, geo_map = {key = "geo_map", i18n_title = "geo_map.geo_map", section = "hosts", visible_iface = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/hosts.html?#geo-map"}, hosts_treemap = {key = "hosts_treemap", i18n_title = "tree_map.hosts_treemap", section = "hosts", visible_iface = true}, host_explorer = {key = "host_explorer", i18n_title = "host_explorer", section = "hosts", visible_iface = true}, containers = {key = "containers", i18n_title = "containers_stats.containers", section = "hosts", visible_iface = true}, pods = {key = "pods", i18n_title = "containers_stats.pods", section = "hosts", visible_iface = true}, -- Interface interface = {key = "interface", i18n_title = "interface_ifname", section = "if_stats", visible_iface = true}, -- Pollers snmp = {key = "snmp", i18n_title = "prefs.snmp", section = "pollers", visible_system = true}, infrastructure_dashboard = {key = "infrastructure_dashboard", i18n_title = "infrastructure_dashboard.infrastructure_dashboard", section = "pollers", visible_iface = false, visible_system = true}, -- Status (Health) system_status = {key = "status", i18n_title = "system_status", section = "system_health", visible_system = true}, interfaces_status = {key = "interfaces_status", i18n_title = "system_interfaces_status", section = "system_health", visible_system = true}, alerts_status = {key = "alerts_status", i18n_title = "system_alerts_status", section = "system_health", visible_system = true}, -- Exporters event_exporters = {key = "event_exporters", i18n_title = "event_exporters.event_exporters", section = "exporters"}, sflow_exporters = {key = "sflow_exporters", i18n_title = "flows_page.sflow_devices", section = "exporters"}, flow_exporters = {key = "flow_exporters", i18n_title = "flow_devices.exporters", section = "exporters", visible_iface = true, visible_system = false, help_link = "https://www.ntop.org"}, -- Settings manage_users = {key = "manage_users", i18n_title = ternary(is_nedge, "nedge.system_users", "manage_users.manage_users"), section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/settings.html#manage-users"}, preferences = {key = "preferences", i18n_title = "prefs.preferences", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/settings.html#preferences"}, scripts_config = {key = "scripts_config", i18n_title = "about.user_scripts", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/user_scripts.html"}, profiles = {key = "profiles", i18n_title = "traffic_profiles.traffic_profiles", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/advanced_features/traffic_profiles.html"}, categories = {key = "categories", i18n_title = "custom_categories.apps_and_categories", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/categories.html#custom-applications"}, category_lists = {key = "category_lists", i18n_title = "category_lists.category_lists", section = "admin", visible_iface = true, visible_system = true}, device_protocols = {key = "device_protocols", i18n_title = "device_protocols.device_protocols", section = "admin", visible_iface = true, visible_system = true}, conf_backup = {key = "conf_backup", i18n_title = "conf_backup.conf_backup", section = "admin", visible_iface = true, visible_system = true}, conf_restore = {key = "conf_restore", i18n_title = "conf_backup.conf_restore", section = "admin", visible_iface = true, visible_system = true}, manage_data = {key = "manage_data", i18n_title = "manage_data.manage_data", section = "admin", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/settings.html#manage-data"}, manage_configurations = { key = "manage_configurations", i18n_title = "manage_configurations.manage_configurations", section = "admin", visible_iface = false, visible_system = true}, -- Notifications endpoint_notifications = {key = "endpoint_notifications", i18n_title = "endpoint_notifications.endpoint_list", section="notifications", visible_iface = false, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/alert_endpoints.html"}, endpoint_recipients = {key = "endpoint_recipients", i18n_title = "endpoint_notifications.enpoint_recipients_list", section="notifications", visible_iface = false, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/alert_endpoints.html"}, -- Tools export_data = {key = "export_data", i18n_title = "manage_data.export", section = "tools"}, remote_assistance = {key = "remote_assistance", i18n_title = "remote_assistance.remote_assistance", section = "tools", help_link = "https://www.ntop.org/guides/ntopng/remote_assistance.html"}, -- Pools host_members = {key = "host_members", i18n_title = "host_pools.host_members", section = "pools", visible_iface = false, visible_system = true}, manage_pools = {key = "manage_pools", i18n_title = "pools.pools", section = "pools", visible_iface = false, visible_system = true}, -- Home live_capture = {key = "live_capture", i18n_title = "live_capture.active_live_captures", section = "home"}, -- Developer directories = {key = "directories", i18n_title = "about.directories", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/distributing_plugins.html"}, plugins = {key = "plugins", i18n_title = "plugins", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/basic_concepts/plugins.html"}, user_scripts_dev = {key = "user_scripts_dev", i18n_title = "about.user_scripts", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/user_scripts.html"}, plugin_browser = {key = "plugin_browser", i18n_title = "plugin_browser", section = "dev", visible_iface = true, visible_system = true}, alert_definitions = {key = "alert_definitions", i18n_title = "about.alert_defines", section = "dev", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/plugins/alert_definitions.html"}, api = {key = "api", i18n_title = "lua_c_api", section = "dev"}, widgets_list = {key = "widgets_list", i18n_title = "developer_section.widgets_list", section = "dev"}, datasources_list = {key = "datasources_list", i18n_title = "developer_section.datasources_list", section = "dev"}, -- Help about = {key = "about", i18n_title = "about.about", section = "about", visible_iface = true, visible_system = true, help_link = "https://www.ntop.org/guides/ntopng/web_gui/help_menu.html?#about"}, telemetry = {key = "telemetry", i18n_title = "telemetry", section = "about", visible_iface = true, visible_system = true}, blog = {key = "blog", i18n_title = "about.ntop_blog", section = "about"}, telegram = {key = "telegram", i18n_title = "about.telegram", section = "about"}, report_issue = {key = "report_issue", i18n_title = "about.report_issue", section = "about"}, manual = {key = "manual", i18n_title = "about.readme_and_manual", section = "about"}, suggest_feature = {key = "suggest_feature", i18n_title = "about.suggest_feature", section = "about"}, -- Just a divider for horizontal rows in the menu divider = {key = "divider"}, -- nEdge gateways_users = {key = "gateways_users", i18n_title = "dashboard.gateways_users", section = "dashboard"}, nedge_flows = {key = "nedge_flows", i18n_title = "flows", section = "hosts"}, users = {key = "users", i18n_title = "users.users", section = "hosts", help_link = "https://www.ntop.org/guides/ntopng/advanced_features/authentication.html"}, system_setup = {key = "system_setup", i18n_title = "nedge.system_setup", section = "system_stats", help_link = "https://www.ntop.org/guides/nedge/get_started.html"}, dhcp_leases = {key = "dhcp_leases", i18n_title = "nedge.dhcp_leases", section = "system_stats"}, port_forwarding = {key = "port_forwarding", i18n_title = "nedge.port_forwarding", section = "system_stats"}, nedge_users = {key = "nedge_users", i18n_title = "manage_users.manage_users", section = "system_stats", help_link = "https://www.ntop.org/guides/nedge/users.html#"}, } -- Extend the menu entries with the plugins local menu, entries_data = plugins_utils.getMenuEntries() page_utils.plugins_menu = menu or {} if entries_data then for k, v in pairs(entries_data) do page_utils.menu_entries[k] = v end end -- ################################# -- NOTE: this function must be called after page_utils.set_active_menu_entry function page_utils.print_page_title(title) local help_link = page_utils.menu_entries[active_entry].help_link or "" print("
") print("

".. title .."

") if (not isEmptyString(help_link)) then print("") end print("
") end -- ################################# -- NOTE: this function is called by the web pages in order to -- set the active entry and section and highlight it into the menu function page_utils.set_active_menu_entry(entry, i18n_params, alt_title) entry = entry or page_utils.menu_entries.traffic_dashboard active_section = entry.section active_entry = entry.key -- check if the page belong to system view -- or if the page belong to interface view -- if both flags are true then it means the page -- is visible in system view and interface view local visible_iface = entry.visible_iface or false local visible_system = entry.visible_system or false if (visible_system and visible_iface) then -- do nothing elseif (visible_system and not page_utils.is_system_view()) then page_utils.set_system_view(true) elseif (visible_iface and page_utils.is_system_view()) then page_utils.set_system_view(false) end page_utils.print_header(alt_title or i18n(entry.i18n_title, i18n_params) or entry.i18n_title) end -- ################################# function page_utils.get_active_section() return(active_section) end function page_utils.get_active_entry() return(active_entry) end -- ################################# -- @brief Encode the HTML entities in a string. -- Useful when printing dissected data which may result in XSS -- e.g., curl -u admin:admin1 "http://devel:3000/" -- @param s The string to escape. -- @return The string with HTML entities properly escaped function page_utils.safe_html(s) if not s then return '' end ret = string.gsub(s, "[}{\">/<'&]", { ["&"] = "&", ["<"] = "<", [">"] = ">", ['"'] = """, ["'"] = "'", ["/"] = "/" }) return(ret) end -- ################################# function page_utils.is_dark_mode_enabled(theme) local dark_mode local theme = theme or ntop.getPref("ntopng.prefs.theme") if (isEmptyString(theme)) then dark_mode = false else dark_mode = (theme == "dark") end return dark_mode end -- ################################# function page_utils.print_header(title) local http_prefix = ntop.getHttpPrefix() local startup_epoch = ntop.getStartupEpoch() local dark_mode = page_utils.is_dark_mode_enabled(_POST["toggle_theme"]) local page_title = i18n("welcome_to", { product=info.product }) if title ~= nil then page_title = info.product .. " - " .. title end print [[ ]] print(page_title) print[[ ]] if (dark_mode) then print[[]] print[[]] else print[[ ]] end print[[ ]] print([[ ]]) end -- ################################# function page_utils.print_header_minimal(title) local http_prefix = ntop.getHttpPrefix() local page_title = i18n("welcome_to", { product=info.product }) if title ~= nil then page_title = info.product .. " - " .. title end print [[ ]] print(page_title) print[[ ]] end -- ################################# function page_utils.print_navbar(title, base_url, items_table, label_url) -- label_url: is the link for navabr-brand, the default link is # print[[ ]] end -- ################################# local menubar_structure = {} function page_utils.init_menubar() menubar_structure = {} end -- ################################# function page_utils.add_menubar_section(section) menubar_structure[#menubar_structure + 1] = section end -- ################################# function page_utils.print_menubar() local is_system_interface = page_utils.is_system_view() local logo_path = nil if (ntop.isPro() or ntop.isnEdge()) and ntop.exists(dirs.installdir .. "/httpdocs/img/custom_logo.png") then logo_path = ntop.getHttpPrefix().."/img/custom_logo.png" end local navbar_style = _POST["toggle_theme"] or ntop.getPref("ntopng.prefs.theme") local active_page = page_utils.get_active_section() local active_subpage = page_utils.get_active_entry() if ((navbar_style == nil) or (navbar_style == "")) then navbar_style = "default" end if (navbar_style == "default") then navbar_style = "dark" end print(' ]]) end -- ############################################## function page_utils.get_interface_list() local interfaces = {} local iface_names = interface.getIfNames() local is_system_interface = page_utils.is_system_view() local num_ifaces = 0 for k,v in pairs(iface_names) do num_ifaces = num_ifaces+1 end local ifs = interface.getStats() local is_pcap_dump = interface.isPcapDumpInterface() local is_packet_interface = interface.isPacketInterface() local views = {} local drops = {} local recording = {} local packetinterfaces = {} local ifnames = {} local ifdescr = {} local ifHdescr = {} local ifCustom = {} local dynamic = {} for v,k in pairs(iface_names) do interface.select(k) local _ifstats = interface.getStats() ifnames[_ifstats.id] = k ifdescr[_ifstats.id] = _ifstats.description --io.write("["..k.."/"..v.."][".._ifstats.id.."] "..ifnames[_ifstats.id].."=".._ifstats.id.."\n") if(_ifstats.isView == true) then views[k] = true end if(_ifstats.isDynamic == true) then dynamic[k] = true end if(recording_utils.isEnabled(_ifstats.id)) then recording[k] = true end if(interface.isPacketInterface()) then packetinterfaces[k] = true end if(_ifstats.stats_since_reset.drops * 100 > _ifstats.stats_since_reset.packets) then drops[k] = true end ifHdescr[_ifstats.id] = getHumanReadableInterfaceName(_ifstats.description.."") ifCustom[_ifstats.id] = _ifstats.customIftype end -- First round: only physical interfaces -- Second round: only virtual interfaces for round = 1, 2 do for k,_ in pairsByValues(ifHdescr, asc) do if ((round == 1) and (ifCustom[k] ~= nil)) or (((round == 2) and (ifCustom[k] == nil))) then goto continue end local v = ifnames[k] -- table.clone needed to modify some parameters while keeping the original unchanged local page_params = table.clone(_GET) page_params.ifid = k local url_query = getPageUrl("", page_params) -- NOTE: the actual interface switching is performed in C in LuaEngine::handle_script_request local action_url = "" if(is_system_interface) then action_url = ntop.getHttpPrefix() .. '/' .. url_query else action_url = url_query end local descr = getHumanReadableInterfaceName(v.."") if(string.contains(descr, "{")) then -- Windows descr = ifdescr[k] else if(descr ~= ifdescr[k]) and (not views[v]) then if(descr == shortenCollapse(ifdescr[k])) then descr = ifdescr[k] else descr = descr .. " (".. ifdescr[k] ..")" -- Add description end end end interfaces[#interfaces+1] = { is_virtual = (round == 2), -- Is the interface virtual or physical? is_paused = isPausedInterface(v), -- Is the interfaces paused? is_selected = (v == ifname) and not is_system_interface, -- Is the in is_dynamic = (dynamic[v]), is_recording = (recording[v]), has_drops = (drops[v]), has_views = (views[v]), ifid = k, action_url = action_url, human_name = descr } ::continue:: end end interface.select(ifs.id.."") return interfaces end function page_utils.generate_info_stats() local _ifstats = interface.getStats() if _ifstats.has_traffic_directions then return ([[
]]) else return ([[ ]]) end end -- ############################################## function page_utils.is_system_view() return ((ntop.getPref("ntopng.prefs.system_mode_enabled") == "1") and isAdministrator()) end -- ############################################## function page_utils.set_system_view(toggle) local t if toggle == "1" or toggle == true then t = "1" elseif toggle == "0" or toggle == false then t = "0" end if t then ntop.setPref("ntopng.prefs.system_mode_enabled", t) end end -- ############################################## --- Check if the current page is valid --- @return boolean True if the current page is in available_pages, false otherwise function page_utils.is_valid_page(selected_page, available_pages) if selected_page == nil then traceError(TRACE_WARNING, TRACE_DEBUG, "selected_pages is nil!") return false end if available_pages == nil then traceError(TRACE_WARNING, TRACE_DEBUG, "available_pages is nil!") return false end if type(available_pages) ~= 'table' then traceError(TRACE_WARNING, TRACE_DEBUG, "available_pages is not a table!") return false end -- do a linear search for _, page in ipairs(available_pages) do if (page == selected_page) then return true end end return false end -- ############################################## -- @brief Prepares the URL which will be used for the redirect after interface switch -- @param ifid The interface identifier of the interface that will be switched -- @param if_type The type of the interface that will be switched -- @return The URL function page_utils.switch_interface_form_action_url(ifid, if_type) local action_url = "" local is_system_interface = page_utils.is_system_view() local page_params = table.clone(_GET) -- Read the currently active page local active_page = page_utils.get_active_section() if is_system_interface then -- If the currently selected interface is system, -- then the switch redirects to the root and not to the -- currently selected page action_url = ntop.getHttpPrefix() .. '/' elseif page_utils.menu_sections[active_page] and page_utils.menu_sections[active_page]["zmq_only"] and if_type ~= "zmq" and if_type ~= "custom" then -- If the interface that will be switched is non-ZMQ, and the currently -- selected page is for ZMQ-only interfaces, then a redirection to root -- is performed, rather than preserving the current page action_url = ntop.getHttpPrefix() .. '/' end -- Attach the interface id of the interface that will be switched page_params.ifid = ifid -- Return the url, preserving all existing page parameters (e.g., host=xx) return getPageUrl(action_url, page_params) end -- ############################################## return page_utils