File: map.lua

package info (click to toggle)
ntopng 5.2.1%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 121,832 kB
  • sloc: javascript: 143,431; cpp: 71,175; ansic: 11,108; sh: 4,687; makefile: 911; python: 587; sql: 512; pascal: 234; perl: 118; ruby: 52; exp: 4
file content (445 lines) | stat: -rw-r--r-- 11,232 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
--
-- (C) 2013-22 - ntop.org
--
local dirs = ntop.getDirs()
package.path = dirs.installdir .. "/scripts/lua/modules/?.lua;" .. package.path

require "lua_utils"
local rest_utils = require("rest_utils")
local callback_utils = require("callback_utils")
local hosts_map_utils = require("hosts_map_utils")

local HostsMapMode = hosts_map_utils.HostsMapMode
local MODES = hosts_map_utils.MODES

local MAX_RADIUS_PX = 30
local MIN_RADIUS_PX = 3

local rc = rest_utils.consts.success.ok
local first_host_table = {}
local second_host_table = {}
local max_radius = 0

-- Note To change the label "Remote Hosts" and "Local Hosts" shown
-- into the chart, just change the value of these names
local first_table_name = "Local Hosts"
local second_table_name = "Remote Hosts"
-- Change check_condition if you want a different condition to put hosts into the tables
local check_condition
local formatHost

local bubble_mode = tonumber(_GET["bubble_mode"]) or 0
local show_remote = _GET["show_remote"] or true

local ifid = _GET["ifid"]

if isEmptyString(ifid) then
   rc = rest_utils.consts.err.invalid_interface
   rest_utils.answer(rc)
   return
end

interface.select(ifid)

-- ###################################################

local function shrinkTable(t, max_num)
   local n = 1
   local t2 = {}
   
   for i,v in pairsByField(t, 'z', rev) do
      if(n < max_num) then
        t2[n] = v
        n = n + 1
      end
   end

   return(t2)
end

-- List of the functions used to get the necessary functions
-- ###################################################

local function allFlows(hostname, host, label)
   local line
   
   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = host["active_flows.as_server"],
      y = host["active_flows.as_client"],
      z = host["bytes.sent"] + host["bytes.rcvd"]
   }      

   return line
end

-- ###################################################

local function unreachableFlows(hostname, host, label)
   local line
   
   if (host["unreachable_flows.as_server"] + host["unreachable_flows.as_client"] > 0) then
      line = {
	 meta = {
	    url_query = "host="..hostname,
	    label = label,
	 },
	 x = host["unreachable_flows.as_server"],
	 y = host["unreachable_flows.as_client"],
	 z = host["bytes.sent"] + host["bytes.rcvd"]
      }
   end
   
   return line
end

-- ###################################################

local function alertedFlows(hostname, host, label)
   local line
   
   if ((host["alerted_flows.as_server"] ~= nil) and
       (host["alerted_flows.as_client"] ~= nil) and
       (host["alerted_flows.as_server"] + host["alerted_flows.as_client"] > 0)) then

      line = {
	 meta = {
	    url_query = "host="..hostname,
	    label = label,
	 },
	 x = host["alerted_flows.as_server"],
	 y = host["alerted_flows.as_client"],
	 z = host["alerted_flows.as_server"] + host["alerted_flows.as_client"]
      }
   end

   return line
end

-- ###################################################

local function dnsQueries(hostname, host, label)
   local line
   
   if ((host["dns"] ~= nil) and
      ((host["dns"]["sent"]["num_queries"] + host["dns"]["rcvd"]["num_queries"]) > 0)) then
      local x = host["dns"]["rcvd"]["num_replies_ok"]
      local y = host["dns"]["sent"]["num_queries"]
      
      line = {
	 meta = {
	    url_query = "host="..hostname,
	    label = label,
	 }, 
	 x = x, 
	 y = y, 
	 z = x + y
      }
   end

   return line
end

-- ###################################################

local function synDistribution(hostname, host, label)
   local line
   local stats = interface.getHostInfo(host["ip"], host["vlan"])
   
   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = stats["pktStats.sent"]["tcp_flags"]["syn"],
      y = stats["pktStats.recv"]["tcp_flags"]["syn"],
      z = host["active_flows.as_client"] + host["active_flows.as_server"]
   }

   return line
end

-- ###################################################

local function synVsRst(hostname, host, label)
   local line
   local stats = interface.getHostInfo(host["ip"], host["vlan"])
   
   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = stats["pktStats.sent"]["tcp_flags"]["syn"],
      y = stats["pktStats.recv"]["tcp_flags"]["rst"],
      z = host["active_flows.as_client"] + host["active_flows.as_server"]
   }

   return line
end

-- ###################################################

local function synVsSynack(hostname, host, label)
   local line
   local stats = interface.getHostInfo(host["ip"], host["vlan"])
   
   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = stats["pktStats.sent"]["tcp_flags"]["syn"],
      y = stats["pktStats.recv"]["tcp_flags"]["synack"],
      z = host["active_flows.as_client"] + host["active_flows.as_server"]
   }

   return line
end

-- ###################################################

local function tcpPktsSentVsRcvd(hostname, host, label)
   local line
   local stats = interface.getHostInfo(host["ip"], host["vlan"])
   
   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = stats["tcp.packets.sent"],
      y = stats["tcp.packets.rcvd"],
      z = stats["tcp.bytes.sent"] + stats["tcp.bytes.rcvd"]
   }

   return line
end

-- ###################################################

local function tcpBytesSentVsRcvd(hostname, host, label)
   local line
   local stats = interface.getHostInfo(host["ip"], host["vlan"])

   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = stats["tcp.bytes.sent"],
      y = stats["tcp.bytes.rcvd"],
      z = stats["tcp.bytes.sent"] + stats["tcp.bytes.rcvd"]
   }
   
   return line
end

-- ###################################################

local function activeAlertFlows(hostname, host, label)
   local line

   if (host["active_alerted_flows"] > 0) then
      line = {
	 meta = {
	    url_query = "host="..hostname,
	    label = label,
	 },
	 x = host["active_flows.as_server"],
	 y = host["active_flows.as_client"],
	 z = host["active_alerted_flows"]
      }
   end

   return line
end

-- ###################################################

local function trafficRatio(hostname, host, label)
   local line

   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = host["bytes_ratio"],
      y = host["pkts_ratio"],
      z = host["bytes.sent"] + host["bytes.rcvd"]
   }
   
   return line
end

-- ###################################################

local function score(hostname, host, label)
   local line

   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = host["score.as_client"],
      y = host["score.as_server"],
      z = host["score.as_client"] + host["score.as_server"]
   }
   
   return line
end

-- ###################################################

local function blacklistedFlowsHosts(hostname, host, label)
   local line

   line = {
      meta = {
	 url_query = "host="..hostname,
	 label = label,
      },
      x = host.num_blacklisted_flows.as_client,
      y = host.num_blacklisted_flows.as_server,
      z = host.num_blacklisted_flows.as_client + host.num_blacklisted_flows.as_server
   }
   
   return line
end

-- ###################################################

local function processHost(hostname, host)
    local line
    local label = host.name

    check_condition = (host.localhost ~= nil) and (host.localhost == true)

    -- starts is defined inside the lua_utils module
    if ((label == nil) or (string.len(label) == 0) or starts(label, "@")) then
        label = hostname
    end

    line = nil

    line = formatHost(hostname, host, label)

    if (line ~= nil) then        
       if (line.z > max_radius) then
	  max_radius = line.z
       end

       if(check_condition) then
	  table.insert(first_host_table, line)
       else
	  table.insert(second_host_table, line)
       end
    end
end

-- ###################################################

-- Switch case used to know which function to format the hosts needs to be used
if (bubble_mode == HostsMapMode.ALL_FLOWS) then
   formatHost = allFlows
elseif (bubble_mode == HostsMapMode.UNREACHABLE_FLOWS) then
   formatHost = unreachableFlows    
elseif (bubble_mode == HostsMapMode.ALERTED_FLOWS) then
   formatHost = alertedFlows
elseif (bubble_mode == HostsMapMode.DNS_QUERIES) then
   formatHost = dnsQueries
elseif (bubble_mode == HostsMapMode.SYN_DISTRIBUTION) then
   formatHost = synDistribution
elseif (bubble_mode == HostsMapMode.SYN_VS_RST) then
   formatHost = synVsRst    
elseif (bubble_mode == HostsMapMode.SYN_VS_SYNACK) then
   formatHost = synVsSynack    
elseif (bubble_mode == HostsMapMode.TCP_PKTS_SENT_VS_RCVD) then
   formatHost = tcpPktsSentVsRcvd    
elseif (bubble_mode == HostsMapMode.TCP_BYTES_SENT_VS_RCVD) then
   formatHost = tcpBytesSentVsRcvd
elseif (bubble_mode == HostsMapMode.ACTIVE_ALERT_FLOWS) then
   formatHost = activeAlertFlows
elseif (bubble_mode == HostsMapMode.TRAFFIC_RATIO) then
   formatHost = trafficRatio    
elseif (bubble_mode == HostsMapMode.SCORE) then
   formatHost = score
elseif (bubble_mode == HostsMapMode.BLACKLISTED_FLOWS_HOSTS) then
   formatHost = blacklistedFlowsHosts
end

-- Callback cycle
if (show_remote) then
    callback_utils.foreachHost(ifname, processHost)
else
    callback_utils.foreachLocalHost(ifname, processHost)
end

-- Reduce the number of hosts to a reasonable value (< max_num)
local max_num = 999
first_host_table  = shrinkTable(first_host_table, max_num)
second_host_table = shrinkTable(second_host_table, max_num)

-- Normalize values
local ratio = max_radius / MAX_RADIUS_PX
for i,v in pairs(first_host_table) do 
    first_host_table[i].z = math.floor(MIN_RADIUS_PX + first_host_table[i].z / ratio) 
end

if (show_remote) then
    for i,v in pairs(second_host_table) do 
        second_host_table[i].z = math.floor(MIN_RADIUS_PX + second_host_table[i].z / ratio) 
    end
end

local base_url = ntop.getHttpPrefix() .. "/lua/host_details.lua"

-- Formatting Answer
rest_utils.answer(rc, {
    series = {
       {data = first_host_table, name = first_table_name, base_url = base_url},
       {data = second_host_table, name = second_table_name, base_url = base_url},
    },
    chart = {
        zoom = {
            autoScaleYaxis = true
        }
    },
    grid = {
        padding = {
            left = 6
        },
    },
    colors = {"rgba(153, 102, 255, 0.45)", "rgba(255, 159, 64, 0.45)"},
    xaxis = {
        type = 'numeric',
        title = {
            text = MODES[bubble_mode + 1].x_label,
        },
        labels = {
            ntop_utils_formatter = MODES[bubble_mode + 1].x_formatter or 'fnone',
        }
    },
    yaxis = {
        type = 'numeric',
        forceNiceScale = true,
        title = {
            text = MODES[bubble_mode + 1].y_label,
            offsetX = 6
        },
        labels = {
            ntop_utils_formatter = MODES[bubble_mode + 1].y_formatter or 'fnone',           
        }
    },
    dataLabels = {
       enabled = false
    },
    tooltip = {
       widget_tooltips_formatter = "showXY"
    }
})