getRuleJSON.py 2.55 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 29 30 31 32
"""
    Copyright (c) 2015 Ad Schellevis

    part of OPNsense (https://www.opnsense.org/)

    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.

    --------------------------------------------------------------------------------------
    script to fetch all suricata rule information into a single json object with the following contents:
        rules : all relevant metadata from the rules including the default enabled or disabled state
33 34
        total_rows: total rowcount for this selection
        parameters: list of parameters used
35 36 37
"""
import json
import sys
38
from rulecache import RuleCache
39 40 41 42 43


# Because rule parsing isn't very useful when the rule definitions didn't change we create a single json file
# to hold the last results (combined with creation date and number of files).
if __name__ == '__main__':
44 45 46 47 48
    rc = RuleCache()
    if rc.isChanged():
        rc.create()

    # load parameters, ignore validation here the search method only processes valid input
49
    parameters = {'limit':'0','offset':'0','sort_by':'', 'filter':''}
50 51 52 53 54 55 56 57 58 59 60 61 62
    cmd=None
    for arg in sys.argv[1:]:
        if cmd is None:
            cmd=arg[1:]
        else:
            if cmd in parameters:
                parameters[cmd] = arg.strip()
            cmd=None

    # dump output
    result=rc.search(**parameters)
    result['parameters'] = parameters
    print (json.dumps(result))