aboutsummaryrefslogtreecommitdiff
path: root/examples/py-flow-dashboard/flow-dash.py
blob: 41102939861fc192bb334d0b7d9eb6f5ff1e03c1 (plain)
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
#!/usr/bin/env python3

import multiprocessing
import os
import sys

sys.path.append(os.path.dirname(sys.argv[0]) + '/../../dependencies')
sys.path.append(os.path.dirname(sys.argv[0]) + '/../share/nDPId')
sys.path.append(sys.base_prefix + '/share/nDPId')
import nDPIsrvd
from nDPIsrvd import nDPIsrvdSocket
import plotly_dash

def nDPIsrvd_worker_onFlowCleanup(instance, current_flow, global_user_data):
    _, shared_flow_dict = global_user_data

    flow_id = current_flow.flow_id

    shared_flow_dict['current-flows'] -= 1

    if flow_id not in shared_flow_dict:
        return True

    shared_flow_dict['total-l4-bytes'] += shared_flow_dict[flow_id]['total-l4-bytes']

    if shared_flow_dict[flow_id]['is_detected'] is True:
        shared_flow_dict['current-detected-flows'] -= 1

    if shared_flow_dict[flow_id]['is_guessed'] is True:
        shared_flow_dict['current-guessed-flows'] -= 1

    if shared_flow_dict[flow_id]['is_not_detected'] is True:
        shared_flow_dict['current-not-detected-flows'] -= 1

    if shared_flow_dict[flow_id]['is_midstream'] is True:
        shared_flow_dict['current-midstream-flows'] -= 1

    if shared_flow_dict[flow_id]['is_risky'] is True:
        shared_flow_dict['current-risky-flows'] -= 1

    del shared_flow_dict[current_flow.flow_id]

    return True

def nDPIsrvd_worker_onJsonLineRecvd(json_dict, instance, current_flow, global_user_data):
    nsock, shared_flow_dict = global_user_data

    shared_flow_dict['total-events'] += 1
    shared_flow_dict['total-json-bytes'] = nsock.received_bytes

    if 'basic_event_name' in json_dict:
        shared_flow_dict['total-base-events'] += 1

    if 'daemon_event_name' in json_dict:
        shared_flow_dict['total-daemon-events'] += 1

    if 'packet_event_name' in json_dict and \
       (json_dict['packet_event_name'] == 'packet' or \
        json_dict['packet_event_name'] == 'packet-flow'):
        shared_flow_dict['total-packet-events'] += 1

    if 'flow_id' not in json_dict:
        return True
    else:
        if current_flow.flow_id != json_dict['flow_id']:
            return False
        flow_id = current_flow.flow_id

    if flow_id not in shared_flow_dict:
        shared_flow_dict[flow_id] = mgr.dict()
        shared_flow_dict[flow_id]['is_detected']     = False
        shared_flow_dict[flow_id]['is_guessed']      = False
        shared_flow_dict[flow_id]['is_not_detected'] = False
        shared_flow_dict[flow_id]['is_midstream']    = False
        shared_flow_dict[flow_id]['is_risky']        = False
        shared_flow_dict[flow_id]['total-l4-bytes']  = 0

        shared_flow_dict[flow_id]['json'] = mgr.dict()

        shared_flow_dict['total-flows']   += 1
        shared_flow_dict['current-flows'] += 1

    if 'flow_tot_l4_payload_len' in json_dict:
        shared_flow_dict[flow_id]['total-l4-bytes'] = json_dict['flow_tot_l4_payload_len']

    if 'midstream' in json_dict and json_dict['midstream'] != 0:
        if shared_flow_dict[flow_id]['is_midstream'] is False:
            shared_flow_dict['total-midstream-flows']   += 1
            shared_flow_dict['current-midstream-flows'] += 1
        shared_flow_dict[flow_id]['is_midstream'] = True

    if 'ndpi' in json_dict:
        # XXX: Will make use of that JSON string in Plotly. Soon..
        shared_flow_dict[flow_id]['json']['ndpi'] = json_dict['ndpi']

        if 'flow_risk' in json_dict['ndpi']:
            if shared_flow_dict[flow_id]['is_risky'] is False:
                shared_flow_dict['total-risky-flows']   += 1
                shared_flow_dict['current-risky-flows'] += 1
            shared_flow_dict[flow_id]['is_risky'] = True

    if 'flow_event_name' not in json_dict:
        return True

    if json_dict['flow_state'] == 'finished' and \
       json_dict['ndpi']['proto'] != 'Unknown' and \
       shared_flow_dict[flow_id]['is_detected'] is False:
        shared_flow_dict['total-detected-flows']   += 1
        shared_flow_dict['current-detected-flows'] += 1
        shared_flow_dict[flow_id]['is_detected'] = True

    if json_dict['flow_event_name'] == 'new':

        shared_flow_dict['total-flow-new-events'] += 1

    elif json_dict['flow_event_name'] == 'update':

        shared_flow_dict['total-flow-update-events'] += 1

    elif json_dict['flow_event_name'] == 'end':

        shared_flow_dict['total-flow-end-events'] += 1

    elif json_dict['flow_event_name'] == 'idle':

        shared_flow_dict['total-flow-idle-events'] += 1

    elif json_dict['flow_event_name'] == 'guessed':

        shared_flow_dict['total-flow-guessed-events'] += 1

        if shared_flow_dict[flow_id]['is_guessed'] is False:
            shared_flow_dict['total-guessed-flows']   += 1
            shared_flow_dict['current-guessed-flows'] += 1
        shared_flow_dict[flow_id]['is_guessed'] = True

    elif json_dict['flow_event_name'] == 'not-detected':

        shared_flow_dict['total-flow-not-detected-events'] += 1

        if shared_flow_dict[flow_id]['is_not_detected'] is False:
            shared_flow_dict['total-not-detected-flows']   += 1
            shared_flow_dict['current-not-detected-flows'] += 1
        shared_flow_dict[flow_id]['is_not_detected'] = True

    elif json_dict['flow_event_name'] == 'detected' or \
         json_dict['flow_event_name'] == 'detection-update':

        if json_dict['flow_event_name'] == 'detection-update':
            shared_flow_dict['total-flow-detection-update-events'] += 1
        else:
            shared_flow_dict['total-flow-detected-events'] += 1

        if shared_flow_dict[flow_id]['is_detected'] is False:
            shared_flow_dict['total-detected-flows']   += 1
            shared_flow_dict['current-detected-flows'] += 1
        shared_flow_dict[flow_id]['is_detected'] = True

        if shared_flow_dict[flow_id]['is_guessed'] is True:
            shared_flow_dict['total-guessed-flows']   -= 1
            shared_flow_dict['current-guessed-flows'] -= 1
        shared_flow_dict[flow_id]['is_guessed'] = False

    return True


def nDPIsrvd_worker(address, shared_flow_dict):
    sys.stderr.write('Recv buffer size: {}\n'
                     .format(nDPIsrvd.NETWORK_BUFFER_MAX_SIZE))
    sys.stderr.write('Connecting to {} ..\n'
                     .format(address[0]+':'+str(address[1])
                             if type(address) is tuple else address))

    try:
        while True:
            try:
                nsock = nDPIsrvdSocket()
                nsock.connect(address)
                nsock.loop(nDPIsrvd_worker_onJsonLineRecvd,
                           nDPIsrvd_worker_onFlowCleanup,
                           (nsock, shared_flow_dict))
            except nDPIsrvd.SocketConnectionBroken:
                sys.stderr.write('Lost connection to {} .. reconnecting\n'
                                 .format(address[0]+':'+str(address[1])
                                         if type(address) is tuple else address))
    except KeyboardInterrupt:
        pass


if __name__ == '__main__':
    argparser = nDPIsrvd.defaultArgumentParser()
    argparser.add_argument('--listen-address', type=str, default='127.0.0.1', help='Plotly listen address')
    argparser.add_argument('--listen-port', type=str, default=8050, help='Plotly listen port')
    args = argparser.parse_args()
    address = nDPIsrvd.validateAddress(args)

    mgr = multiprocessing.Manager()
    shared_flow_dict = mgr.dict()

    shared_flow_dict['total-events']             = 0
    shared_flow_dict['total-flow-new-events']    = 0
    shared_flow_dict['total-flow-update-events'] = 0
    shared_flow_dict['total-flow-end-events']    = 0
    shared_flow_dict['total-flow-idle-events']   = 0
    shared_flow_dict['total-flow-detected-events'] = 0
    shared_flow_dict['total-flow-detection-update-events'] = 0
    shared_flow_dict['total-flow-guessed-events'] = 0
    shared_flow_dict['total-flow-not-detected-events'] = 0
    shared_flow_dict['total-packet-events']      = 0
    shared_flow_dict['total-base-events']        = 0
    shared_flow_dict['total-daemon-events']      = 0

    shared_flow_dict['total-json-bytes']         = 0
    shared_flow_dict['total-l4-bytes']           = 0
    shared_flow_dict['total-flows']              = 0
    shared_flow_dict['total-detected-flows']     = 0
    shared_flow_dict['total-risky-flows']        = 0
    shared_flow_dict['total-midstream-flows']    = 0
    shared_flow_dict['total-guessed-flows']      = 0
    shared_flow_dict['total-not-detected-flows'] = 0

    shared_flow_dict['current-flows']              = 0
    shared_flow_dict['current-detected-flows']     = 0
    shared_flow_dict['current-risky-flows']        = 0
    shared_flow_dict['current-midstream-flows']    = 0
    shared_flow_dict['current-guessed-flows']      = 0
    shared_flow_dict['current-not-detected-flows'] = 0

    nDPIsrvd_job = multiprocessing.Process(target=nDPIsrvd_worker,
                                           args=(address, shared_flow_dict))
    nDPIsrvd_job.start()

    web_job = multiprocessing.Process(target=plotly_dash.web_worker,
                                      args=(shared_flow_dict, args.listen_address, args.listen_port))
    web_job.start()

    nDPIsrvd_job.join()
    web_job.terminate()
    web_job.join()