OPNSense - Backup Rules to CSV

opnsense-backup-rules-to-csv.py

from csv import DictWriter
import xml.etree.ElementTree as ET

# reads unencrypted OPNSense backup file and extracts its rules in CSV format

FILE_IN = 'firewall.xml'
FILE_OUT = 'firewall.csv'
FIELDS = [
    'uuid', 'type', 'interface', 'ipprotocol', 'statetype', 'descr', 'direction', 'floating', 'log', 'quick',
    'protocol', 'source', 'destination', 'category', 'disabled', 'gateway', 'icmptype', 'associated-rule-id',
    'updated', 'created',
]

tree = ET.parse(FILE_IN)

rules = []

for raw in tree.getroot().find('filter'):
    if 'uuid' not in raw.attrib:
        continue

    rules.append({'uuid': raw.attrib['uuid'], **{cnf.tag: cnf.text.strip() for cnf in raw}})

print('RULE COUNT:', len(rules))

with open(FILE_OUT, 'w', encoding='utf-8') as target:
    writer = DictWriter(target, fieldnames=FIELDS)
    writer.writeheader()
    for entry in rules:
        writer.writerow(entry)