queryAlertLog.py 5.02 KB
Newer Older
1
#!/usr/local/bin/python2.7
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
"""
    Copyright (c) 2015 Ad Schellevis
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.

    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.

    --------------------------------------------------------------------------------------
29

30 31
    query suricata alert log
"""
32

33
import os.path
34 35 36 37 38
import re
import sre_constants
import shlex
import ujson
from lib.log import reverse_log_reader
39
from lib.params import update_params
40
from lib import suricata_alert_log
41

42 43
if __name__ == '__main__':
    # handle parameters
44 45
    parameters = {'limit': '0', 'offset': '0', 'filter': '', 'fileid': ''}
    update_params(parameters)
46 47 48

    # choose logfile by number
    if parameters['fileid'].isdigit():
49
        suricata_log = '%s.%d' % (suricata_alert_log, int(parameters['fileid']))
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    else:
        suricata_log = suricata_alert_log

    if parameters['limit'].isdigit():
        limit = int(parameters['limit'])
    else:
        limit = 0

    if parameters['offset'].isdigit():
        offset = int(parameters['offset'])
    else:
        offset = 0

    data_filters = {}
    data_filters_comp = {}
65 66 67 68
    for filter_txt in shlex.split(parameters['filter']):
        filterField = filter_txt.split('/')[0]
        if filter_txt.find('/') > -1:
            data_filters[filterField] = '/'.join(filter_txt.split('/')[1:])
69 70 71 72 73 74 75
            filter_regexp = data_filters[filterField]
            filter_regexp = filter_regexp.replace('*', '.*')
            filter_regexp = filter_regexp.lower()
            try:
                data_filters_comp[filterField] = re.compile(filter_regexp)
            except sre_constants.error:
                # remove illegal expression
76
                # del data_filters[filterField]
77 78 79 80 81 82 83 84 85
                data_filters_comp[filterField] = re.compile('.*')

    # filter one specific log line
    if 'filepos' in data_filters and data_filters['filepos'].isdigit():
        log_start_pos = int(data_filters['filepos'])
    else:
        log_start_pos = None

    # query suricata eve log
86
    result = {'filters': data_filters, 'rows': [], 'total_rows': 0, 'origin': suricata_log.split('/')[-1]}
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    if os.path.exists(suricata_log):
        for line in reverse_log_reader(filename=suricata_log, start_pos=log_start_pos):
            try:
                record = ujson.loads(line['line'])
            except ValueError:
                # can not handle line
                record = {}

            # only process valid alert items
            if 'alert' in record:
                # add position in file
                record['filepos'] = line['pos']
                record['fileid'] = parameters['fileid']
                # flatten structure
                record['alert_sid'] = record['alert']['signature_id']
102
                record['alert_action'] = record['alert']['action']
103 104 105 106 107 108 109
                record['alert'] = record['alert']['signature']

                # use filters on data (using regular expressions)
                do_output = True
                for filterKeys in data_filters:
                    filter_hit = False
                    for filterKey in filterKeys.split(','):
110 111
                        if filterKey in record and data_filters_comp[filterKeys].match(
                                ('%s' % record[filterKey]).lower()):
112 113 114 115 116 117 118 119 120 121 122 123 124
                            filter_hit = True

                    if not filter_hit:
                        do_output = False
                if do_output:
                    result['total_rows'] += 1
                    if (len(result['rows']) < limit or limit == 0) and result['total_rows'] >= offset:
                        result['rows'].append(record)
                    elif result['total_rows'] > offset + limit:
                        # do not fetch data until end of file...
                        break

            # only try to fetch one line when filepos is given
125
            if log_start_pos is not None:
126 127 128 129
                break

    # output results
    print(ujson.dumps(result))