Page MenuHomeVyOS Platform
Files F119064201

service_suricata.py
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

service_suricata.py
View Options

#!/usr/bin/env python3
#
# Copyright (C) 2024 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
from sys import exit
from vyos.base import Warning
from vyos.config import Config
from vyos.template import render
from vyos.utils.process import call
from vyos import ConfigError
from vyos import airbag
airbag.enable()
config_file = '/run/suricata/suricata.yaml'
rotate_file = '/etc/logrotate.d/suricata'
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
base = ['service', 'suricata']
if not conf.exists(base):
return None
suricata = conf.get_config_dict(base, key_mangling=('-', '_'),
get_first_key=True, with_recursive_defaults=True)
return suricata
# https://en.wikipedia.org/wiki/Topological_sorting#Depth-first_search
def topological_sort(source):
sorted_nodes = []
permanent_marks = set()
temporary_marks = set()
def visit(n, v):
if n in permanent_marks:
return
if n in temporary_marks:
raise ConfigError('At least one cycle exists in the referenced groups')
temporary_marks.add(n)
for m in v.get('group', []):
m = m.lstrip('!').replace('-', '_')
if m not in source:
raise ConfigError(f'Undefined referenced group "{m}"')
visit(m, source[m])
temporary_marks.remove(n)
permanent_marks.add(n)
sorted_nodes.append((n, v))
while len(permanent_marks) < len(source):
n = next(n for n in source.keys() if n not in permanent_marks)
visit(n, source[n])
return sorted_nodes
def verify(suricata):
if not suricata:
return None
if 'interface' not in suricata:
raise ConfigError('No interfaces configured!')
if 'address_group' not in suricata:
raise ConfigError('No address-group configured!')
if 'port_group' not in suricata:
raise ConfigError('No port-group configured!')
try:
topological_sort(suricata['address_group'])
except (ConfigError,StopIteration) as e:
raise ConfigError(f'Invalid address-group: {e}')
try:
topological_sort(suricata['port_group'])
except (ConfigError,StopIteration) as e:
raise ConfigError(f'Invalid port-group: {e}')
def generate(suricata):
if not suricata:
for file in [config_file, rotate_file]:
if os.path.isfile(file):
os.unlink(file)
return None
# Config-related formatters
def to_var(s:str):
return s.replace('-','_').upper()
def to_val(s:str):
return s.replace('-',':')
def to_ref(s:str):
if s[0] == '!':
return '!$' + to_var(s[1:])
return '$' + to_var(s)
def to_config(kind:str):
def format_group(group):
(name, value) = group
property = [to_val(property) for property in value.get(kind,[])]
group = [to_ref(group) for group in value.get('group',[])]
return (to_var(name), property + group)
return format_group
# Format the address group
suricata['address_group'] = map(to_config('address'),
topological_sort(suricata['address_group']))
# Format the port group
suricata['port_group'] = map(to_config('port'),
topological_sort(suricata['port_group']))
render(config_file, 'ids/suricata.j2', {'suricata': suricata})
render(rotate_file, 'ids/suricata_logrotate.j2', suricata)
return None
def apply(suricata):
systemd_service = 'suricata.service'
if not suricata or 'interface' not in suricata:
# Stop suricata service if removed
call(f'systemctl stop {systemd_service}')
else:
Warning('To fetch the latest rules, use "update suricata"; '
'To periodically fetch the latest rules, '
'use the task scheduler!')
call(f'systemctl restart {systemd_service}')
return None
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)

File Metadata

Mime Type
text/x-script.python
Expires
Fri, Nov 6, 9:38 AM (10 h, 22 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4653992
Default Alt Text
service_suricata.py (4 KB)

Event Timeline