summaryrefslogtreecommitdiff
path: root/examples/py-semantic-validation/py-semantic-validation.py
blob: d4423467e36f90c085786f97c7f56905e5309b33 (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
#!/usr/bin/env python3

import os
import sys

sys.path.append(os.path.dirname(sys.argv[0]) + '/../share/nDPId')
sys.path.append(os.path.dirname(sys.argv[0]) + '/../usr/share/nDPId')
try:
    import nDPIsrvd
    from nDPIsrvd import nDPIsrvdSocket, TermColor
except ImportError:
    sys.path.append(os.path.dirname(sys.argv[0]) + '/../../dependencies')
    import nDPIsrvd
    from nDPIsrvd import nDPIsrvdSocket, TermColor

global lowest_flow_id_for_new_flow
lowest_flow_id_for_new_flow = 0

class Stats:
    event_counter   = dict()

    lines_processed = 0
    print_dot_every = 10
    print_nmb_every = print_dot_every * 5

    def resetEventCounter(self):
        keys = ['init','reconnect','shutdown', \
                'new','end','idle','guessed','detected','detection-update','not-detected', \
                'packet', 'packet-flow']
        for k in keys:
            self.event_counter[k] = 0

    def incrementEventCounter(self, json_dict):
        try:
            if 'daemon_event_name' in json_dict:
                self.event_counter[json_dict['daemon_event_name']] += 1
            if 'flow_event_name' in json_dict:
                self.event_counter[json_dict['flow_event_name']] += 1
            if 'packet_event_name' in json_dict:
                self.event_counter[json_dict['packet_event_name']] += 1
        except KeyError as e:
            raise RuntimeError('Semantic validation failed for event counter '
                               'which received an invalid key: {}'.format(str(e)))

    def verifyEventCounter(self):
        if self.event_counter['shutdown'] != self.event_counter['init'] or self.event_counter['init'] == 0:
            return False
        if self.event_counter['new'] != self.event_counter['end'] + self.event_counter['idle']:
            return False
        if self.event_counter['new'] < self.event_counter['detected'] + self.event_counter['not-detected']:
            return False
        if self.event_counter['new'] < self.event_counter['guessed'] + self.event_counter['not-detected']:
            return False

        return True

    def getEventCounterStr(self):
        keys = [ [ 'init','reconnect','shutdown' ], \
                 [ 'new','end','idle' ], \
                 [ 'guessed','detected','detection-update','not-detected' ], \
                 [ 'packet', 'packet-flow' ] ]
        retval = str()
        retval += '-' * 98 + '--\n'
        for klist in keys:
            for k in klist:
                retval += '| {:<16}: {:<4} '.format(k, self.event_counter[k])
            retval += '\n--' + '-' * 98 + '\n'
        return retval

    def __init__(self):
        self.resetEventCounter()

class SemanticValidationException(Exception):
    def __init__(self, current_flow, text):
        self.text = text
        self.current_flow = current_flow
    def __str__(self):
        if self.current_flow is None:
            return '{}'.format(self.text)
        else:
            return 'Flow ID {}: {}'.format(self.current_flow.flow_id, self.text)

def onJsonLineRecvd(json_dict, current_flow, global_user_data):
    global lowest_flow_id_for_new_flow
    stats = global_user_data
    stats.incrementEventCounter(json_dict)

    try:
        semdict = current_flow.semdict
    except AttributeError:
        try:
            semdict = current_flow.semdict = dict()
        except AttributeError:
            semdict = dict()

    if 'current_flow' in semdict:
        if semdict['current_flow'] != current_flow:
            raise SemanticValidationException(current_flow,
                                              'Semantic dictionary flow reference != current flow reference: ' \
                                              '{} != {}'.format(semdict['current_flow'], current_flow))
    else:
        semdict['current_flow'] = current_flow

    if current_flow is not None:
        if 'flow_id' in semdict:
            if semdict['flow_id'] != current_flow.flow_id or \
               semdict['flow_id'] != json_dict['flow_id']:
                raise SemanticValidationException(current_flow,
                                                  'Semantic dictionary flow id != current flow id != JSON dictionary flow id: ' \
                                                  '{} != {} != {}'.format(semdict['flow_id'], \
                                                  current_flow.flow_id, json_dict['flow_id']))
        else:
            if json_dict['flow_id'] != current_flow.flow_id:
                raise SemanticValidationException(current_flow,
                                                  'JSON dictionary flow id != current flow id: ' \
                                                  '{} != {}'.format(json_dict['flow_id'], current_flow.flow_id))
            semdict['flow_id'] = json_dict['flow_id']

    if 'flow_event_name' in json_dict:
        if json_dict['flow_event_name'] == 'end' or \
           json_dict['flow_event_name'] == 'idle':
            pass
        elif json_dict['flow_event_name'] == 'new':
            if lowest_flow_id_for_new_flow > current_flow.flow_id:
                raise SemanticValidationException(current_flow,
                                                  'JSON dictionary lowest flow id for new flow > current flow id: ' \
                                                  '{} != {}'.format(lowest_flow_id_for_new_flow, current_flow.flow_id))
            current_flow.flow_new_seen = True
            if lowest_flow_id_for_new_flow == 0:
                lowest_flow_id_for_new_flow = current_flow.flow_id
        elif json_dict['flow_event_name'] == 'detected' or \
             json_dict['flow_event_name'] == 'not-detected':
            try:
                if current_flow.flow_detection_finished is True:
                    raise SemanticValidationException(current_flow,
                                                      'Flow detection already finished, but detected/not-detected event received.')
            except AttributeError:
                pass
            current_flow.flow_detection_finished = True

    try:
        if current_flow.flow_new_seen is True and lowest_flow_id_for_new_flow > current_flow.flow_id:
            raise SemanticValidationException(current_flow, 'Lowest flow id for flow > current flow id: ' \
                                              '{} > {}'.format(lowest_flow_id_for_new_flow, current_flow.flow_id))
    except AttributeError:
        pass

    global_user_data.lines_processed += 1
    if global_user_data.lines_processed % global_user_data.print_dot_every == 0:
        sys.stdout.write('.')
        sys.stdout.flush()
    print_nmb_every = global_user_data.print_nmb_every + (len(str(global_user_data.lines_processed)) * global_user_data.print_dot_every)
    if global_user_data.lines_processed % print_nmb_every == 0:
        sys.stdout.write(str(global_user_data.lines_processed))
        sys.stdout.flush()

    return True

if __name__ == '__main__':
    argparser = nDPIsrvd.defaultArgumentParser()
    argparser.add_argument('--strict', action='store_true', default=False, help='Require and validate a full nDPId application lifecycle.')
    args = argparser.parse_args()
    address = nDPIsrvd.validateAddress(args)

    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))

    nsock = nDPIsrvdSocket()
    nsock.connect(address)
    stats = Stats()
    try:
        nsock.loop(onJsonLineRecvd, stats)
    except nDPIsrvd.SocketConnectionBroken as err:
        sys.stderr.write('\n{}\n'.format(err))
    except KeyboardInterrupt:
        print()

    sys.stderr.write('\nEvent counter:\n' + stats.getEventCounterStr() + '\n')
    if args.strict is True:
        if stats.verifyEventCounter() is False:
            sys.stderr.write('Event counter verification failed. (`--strict\')\n')
            sys.exit(1)