Implement remote assistance

- It enables a VPN via n2n - Remote assistance will be automatically disabled after 1 day - Optionally it's possible to give admin access to the support
2026-04-29 15:39:33 +00:00 · 2018-11-23 13:03:11 +01:00 · 2018-11-23 13:03:11 +01:00 · eac278a28d
commit eac278a28d
parent 578e1362da
19 changed files with 857 additions and 59 deletions
--- a/scripts/lua/modules/remote_assistance.lua
+++ b/scripts/lua/modules/remote_assistance.lua
@ -0,0 +1,142 @@
+--
+-- (C) 2018 - ntop.org
+--
+
+local dirs = ntop.getDirs()
+package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path
+require "lua_utils"
+local os_utils = require("os_utils")
+
+local SERVICE_NAME = "n2n"
+local DEVICE_IP = "192.168.166.1"
+local SUPERNODE_ADDRESS = "dns.ntop.org:7777"
+local CONF_DIR = dirs.workingdir.."/n2n"
+local CONF_FILE = CONF_DIR .. "/edge.conf"
+local TEMP_ADMIN_PASSWORD_KEY = "ntopng.prefs.temp_admin_password"
+local REMOTE_ASSISTANCE_EXPIRATION = 86400 --[[ keep active for max 1 day ]]
+local remote_assistance = {}
+
+-- ########################################################
+
+function remote_assistance.isAvailable()
+  return true
+  --return isAdministrator() and os_utils.hasService(SERVICE_NAME)
+end
+
+-- ########################################################
+
+function remote_assistance.enableTempAdminAccess(key)
+  ntop.setPref(TEMP_ADMIN_PASSWORD_KEY, key, REMOTE_ASSISTANCE_EXPIRATION) 
+end
+
+-- ########################################################
+
+function remote_assistance.disableTempAdminAccess()
+  ntop.delCache(TEMP_ADMIN_PASSWORD_KEY)
+end
+
+-- ########################################################
+
+function remote_assistance.createConfig(community, key)
+  local prefs = ntop.getPrefs()
+
+  if not ntop.mkdir(CONF_DIR) then
+    return false
+  end
+
+  local f = io.open(CONF_FILE, "w")
+
+  if not f then
+    return false
+  end
+
+  f:write("-d=n2n0\n")
+  f:write("-l=".. SUPERNODE_ADDRESS .."\n")
+  f:write("-c=".. community .."\n")
+  f:write("-k=".. key .."\n")
+
+  if not isEmptyString(prefs.user) then
+    -- uid=999(ntopng) gid=999(ntopng) groups=999(ntopng)
+    local res = os_utils.execWithOutput("id " .. prefs.user) or ""
+    local uid = res:gmatch("uid=(%d+)")()
+    local gid = res:gmatch("gid=(%d+)")()
+
+    if((uid ~= nil) and (gid ~= nil)) then
+      f:write("-u=".. uid .."\n");
+      f:write("-g=".. gid .."\n");
+    end
+  end
+
+  f:write("-a=".. DEVICE_IP .."\n")
+
+  f:close()
+
+  return true
+end
+
+-- ########################################################
+
+function remote_assistance.isEnabled()
+  return(ntop.getPref("ntopng.prefs.remote_assistance.enabled") == "1")
+end
+
+-- ########################################################
+
+function remote_assistance.enableAndStart()
+  ntop.setPref("ntopng.prefs.remote_assistance.enabled", "1")
+  ntop.setPref("ntopng.prefs.remote_assistance.expires_on", tostring(os.time() + REMOTE_ASSISTANCE_EXPIRATION))
+  os_utils.enableService(SERVICE_NAME)
+  return os_utils.restartService(SERVICE_NAME)
+end
+
+-- ########################################################
+
+function remote_assistance.disableAndStop()
+  ntop.delCache("ntopng.prefs.remote_assistance.enabled")
+  os_utils.disableService(SERVICE_NAME)
+  return os_utils.stopService(SERVICE_NAME)
+end
+
+-- ########################################################
+
+function remote_assistance.checkExpiration()
+  if remote_assistance.isEnabled() then
+    local expires_on = tonumber(ntop.getPref("ntopng.prefs.remote_assistance.expires_on"))
+
+    if((expires_on == nil) or (os.time() >= expires_on)) then
+      remote_assistance.disableTempAdminAccess()
+      remote_assistance.disableAndStop()
+    end
+  end
+end
+
+-- ########################################################
+
+function remote_assistance.getStatus()
+  return os_utils.serviceStatus(SERVICE_NAME)
+end
+
+-- ########################################################
+
+function remote_assistance.statusLabel()
+  local rv = os_utils.serviceStatus(SERVICE_NAME)
+  local color
+  local status
+
+  if rv == "active" then
+    status = i18n("running")
+    color = "success"
+  elseif rv == "inactive" then
+    status = i18n("nedge.status_inactive")
+    color = "default"
+  else -- error
+    status = i18n("error")
+    color = "danger"
+  end
+
+  return [[<span class="label label-]] .. color .. [[">]] .. status ..[[</span>]]
+end
+
+-- ########################################################
+
+return remote_assistance