From 0bbe8d655df4bc50d70aeef2d3199a73e0af9f03 Mon Sep 17 00:00:00 2001 From: Viacheslav Hletenko Date: Sat, 28 May 2022 18:41:21 +0000 Subject: event-handler: T3083: Add simple event-handler Event-handler allows executing a custom script when in logs it detects configured "pattern" A simple implemenation set system event-handler first pattern '.*ssh2.*' set system event-handler first script '/config/scripts/hello.sh' --- interface-definitions/system-event-handler.xml.in | 27 +++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 interface-definitions/system-event-handler.xml.in (limited to 'interface-definitions') diff --git a/interface-definitions/system-event-handler.xml.in b/interface-definitions/system-event-handler.xml.in new file mode 100644 index 000000000..f5d8afabd --- /dev/null +++ b/interface-definitions/system-event-handler.xml.in @@ -0,0 +1,27 @@ + + + + + + + Event handler name + + + + + Match pattern (regex) + + + + + Event handler script file + + + + + + + + + + -- cgit v1.2.3 From d542bf338aa1638b082a141163db5437ce7a33a9 Mon Sep 17 00:00:00 2001 From: Viacheslav Hletenko Date: Tue, 7 Jun 2022 06:54:39 +0000 Subject: event-handler: T3083: Move system to service event-handler Move 'system event-handler' to 'service event-handler' --- interface-definitions/service-event-handler.xml.in | 27 +++++++ interface-definitions/system-event-handler.xml.in | 27 ------- src/conf_mode/service_event_handler.py | 84 ++++++++++++++++++++++ src/conf_mode/system_event_handler.py | 84 ---------------------- 4 files changed, 111 insertions(+), 111 deletions(-) create mode 100644 interface-definitions/service-event-handler.xml.in delete mode 100644 interface-definitions/system-event-handler.xml.in create mode 100755 src/conf_mode/service_event_handler.py delete mode 100755 src/conf_mode/system_event_handler.py (limited to 'interface-definitions') diff --git a/interface-definitions/service-event-handler.xml.in b/interface-definitions/service-event-handler.xml.in new file mode 100644 index 000000000..0ed26b213 --- /dev/null +++ b/interface-definitions/service-event-handler.xml.in @@ -0,0 +1,27 @@ + + + + + + + Event handler name + + + + + Match pattern (regex) + + + + + Event handler script file + + + + + + + + + + diff --git a/interface-definitions/system-event-handler.xml.in b/interface-definitions/system-event-handler.xml.in deleted file mode 100644 index f5d8afabd..000000000 --- a/interface-definitions/system-event-handler.xml.in +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - Event handler name - - - - - Match pattern (regex) - - - - - Event handler script file - - - - - - - - - - diff --git a/src/conf_mode/service_event_handler.py b/src/conf_mode/service_event_handler.py new file mode 100755 index 000000000..cf4aba49b --- /dev/null +++ b/src/conf_mode/service_event_handler.py @@ -0,0 +1,84 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2022 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 . + +import json +from pathlib import Path + +from vyos.config import Config +from vyos.util import call +from vyos import ConfigError +from vyos import airbag + +airbag.enable() + +service_name = 'vyos-event-handler' +service_conf = Path(f'/run/{service_name}.conf') + + +def get_config(config=None): + if config: + conf = config + else: + conf = Config() + + base = ['service', 'event-handler'] + config = conf.get_config_dict(base, + get_first_key=True, + no_tag_node_value_mangle=True) + + return config + + +def verify(config): + # bail out early - looks like removal from running config + if not config: + return None + + for name, event_config in config.items(): + if 'pattern' not in event_config or 'script' not in event_config: + raise ConfigError( + 'Event-handler: both pattern and script items are mandatory!') + + +def generate(config): + if not config: + # Remove old config and return + service_conf.unlink(missing_ok=True) + return None + + # Write configuration file + conf_json = json.dumps(config, indent=4) + service_conf.write_text(conf_json) + + return None + + +def apply(config): + if config: + call(f'systemctl restart {service_name}.service') + else: + call(f'systemctl stop {service_name}.service') + + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/conf_mode/system_event_handler.py b/src/conf_mode/system_event_handler.py deleted file mode 100755 index 9f91e99fc..000000000 --- a/src/conf_mode/system_event_handler.py +++ /dev/null @@ -1,84 +0,0 @@ -#!/usr/bin/env python3 -# -# Copyright (C) 2022 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 . - -import json -from pathlib import Path - -from vyos.config import Config -from vyos.util import call -from vyos import ConfigError -from vyos import airbag - -airbag.enable() - -service_name = 'vyos-event-handler' -service_conf = Path(f'/run/{service_name}.conf') - - -def get_config(config=None): - if config: - conf = config - else: - conf = Config() - - base = ['system', 'event-handler'] - config = conf.get_config_dict(base, - get_first_key=True, - no_tag_node_value_mangle=True) - - return config - - -def verify(config): - # bail out early - looks like removal from running config - if not config: - return None - - for name, event_config in config.items(): - if 'pattern' not in event_config or 'script' not in event_config: - raise ConfigError( - 'Event-handler: both pattern and script items are mandatory!') - - -def generate(config): - if not config: - # Remove old config and return - service_conf.unlink(missing_ok=True) - return None - - # Write configuration file - conf_json = json.dumps(config, indent=4) - service_conf.write_text(conf_json) - - return None - - -def apply(config): - if config: - call(f'systemctl restart {service_name}.service') - else: - call(f'systemctl stop {service_name}.service') - - -if __name__ == '__main__': - try: - c = get_config() - verify(c) - generate(c) - apply(c) - except ConfigError as e: - print(e) - exit(1) -- cgit v1.2.3 From 03d236f3905ac84db293d1dab8ac78556fb2bdbf Mon Sep 17 00:00:00 2001 From: Viacheslav Hletenko Date: Tue, 7 Jun 2022 08:54:32 +0000 Subject: event-handler: T3083: Add arguments and environment options XML --- interface-definitions/service-event-handler.xml.in | 34 ++++++++++++++++++---- 1 file changed, 29 insertions(+), 5 deletions(-) (limited to 'interface-definitions') diff --git a/interface-definitions/service-event-handler.xml.in b/interface-definitions/service-event-handler.xml.in index 0ed26b213..3e96013c7 100644 --- a/interface-definitions/service-event-handler.xml.in +++ b/interface-definitions/service-event-handler.xml.in @@ -12,14 +12,38 @@ Match pattern (regex) - + Event handler script file - - - - + + + + Script arguments + + + + + Script environment arguments + + + + + Environment value + + + + + + + Path to the script + + + + + + + -- cgit v1.2.3 From 06c0d2f2f9f4b9c97eb9868df166d787ca367ee7 Mon Sep 17 00:00:00 2001 From: zsdc Date: Tue, 7 Jun 2022 14:34:49 +0300 Subject: event-handler: T3083: Extended event-handler features * Added the ability to filter by a syslog identifier * Added the ability to pass arguments to a script * Added the ability to pass preconfigured environment variables to a script * A message that triggered a script is now passed in the `message` variable and can be used in a script * Replaced `call()` to `run()`, since stdout are not need to be printed --- interface-definitions/service-event-handler.xml.in | 18 +++- src/conf_mode/service_event_handler.py | 13 ++- src/system/vyos-event-handler.py | 110 ++++++++++++++------- 3 files changed, 100 insertions(+), 41 deletions(-) (limited to 'interface-definitions') diff --git a/interface-definitions/service-event-handler.xml.in b/interface-definitions/service-event-handler.xml.in index 3e96013c7..ed6d41d1b 100644 --- a/interface-definitions/service-event-handler.xml.in +++ b/interface-definitions/service-event-handler.xml.in @@ -7,11 +7,23 @@ Event handler name - + - Match pattern (regex) + Logs filter settings - + + + + Match pattern (regex) + + + + + Identifier of a process in syslog (string) + + + + Event handler script file diff --git a/src/conf_mode/service_event_handler.py b/src/conf_mode/service_event_handler.py index cf4aba49b..bb12da11d 100755 --- a/src/conf_mode/service_event_handler.py +++ b/src/conf_mode/service_event_handler.py @@ -18,7 +18,7 @@ import json from pathlib import Path from vyos.config import Config -from vyos.util import call +from vyos.util import call, dict_search from vyos import ConfigError from vyos import airbag @@ -48,9 +48,16 @@ def verify(config): return None for name, event_config in config.items(): - if 'pattern' not in event_config or 'script' not in event_config: + if not dict_search('filter.pattern', event_config) or not dict_search( + 'script.path', event_config): raise ConfigError( - 'Event-handler: both pattern and script items are mandatory!') + 'Event-handler: both pattern and script path items are mandatory' + ) + + if dict_search('script.environment.message', event_config): + raise ConfigError( + 'Event-handler: "message" environment variable is reserved for log message text' + ) def generate(config): diff --git a/src/system/vyos-event-handler.py b/src/system/vyos-event-handler.py index f4b793dbe..691f674b2 100755 --- a/src/system/vyos-event-handler.py +++ b/src/system/vyos-event-handler.py @@ -18,12 +18,12 @@ import argparse import select import re import json -from os import getpid +from os import getpid, environ from pathlib import Path from signal import signal, SIGTERM, SIGINT from systemd import journal from sys import exit -from vyos.util import call +from vyos.util import run, dict_search # Identify this script my_pid = getpid() @@ -41,25 +41,72 @@ def handle_signal(signal_type, frame): exit(0) -# Execute script safely -def script_run(pattern: str, script_path: str) -> None: - try: - call(script_path) - journal.send( - f'Pattern found: "{pattern}", script executed: "{script_path}"', - SYSLOG_IDENTIFIER=my_name) - except Exception as err: - journal.send( - f'Pattern found: "{pattern}", failed to execute script "{script_path}": {err}', - SYSLOG_IDENTIFIER=my_name) - - -# iterate trough regexp items -def analyze_message(message: str, regex_patterns: dict) -> None: - for pattern_compiled, pattern_config in regex_patterns.items(): - if pattern_compiled.match(message): - script_run(pattern_config['pattern_raw'], - pattern_config['pattern_script']) +# Class for analyzing and process messages +class Analyzer: + # Initialize settings + def __init__(self, config: dict) -> None: + self.config = {} + # Prepare compiled regex objects + for event_id, event_config in config.items(): + script = dict_search('script.path', event_config) + # Check for arguments + if dict_search('script.arguments', event_config): + script_arguments = dict_search('script.arguments', event_config) + script = f'{script} {script_arguments}' + # Prepare environment + environment = environ + # Check for additional environment options + if dict_search('script.environment', event_config): + for env_variable, env_value in dict_search( + 'script.environment', event_config).items(): + environment[env_variable] = env_value.get('value') + # Create final config dictionary + pattern_raw = event_config['filter']['pattern'] + pattern_compiled = re.compile( + rf'{event_config["filter"]["pattern"]}') + pattern_config = { + pattern_compiled: { + 'pattern_raw': + pattern_raw, + 'syslog_id': + dict_search('filter.syslog_identifier', event_config), + 'pattern_script': { + 'path': script, + 'environment': environment + } + } + } + self.config.update(pattern_config) + + # Execute script safely + def script_run(self, pattern: str, script_path: str, + script_env: dict) -> None: + try: + run(script_path, env=script_env) + journal.send( + f'Pattern found: "{pattern}", script executed: "{script_path}"', + SYSLOG_IDENTIFIER=my_name) + except Exception as err: + journal.send( + f'Pattern found: "{pattern}", failed to execute script "{script_path}": {err}', + SYSLOG_IDENTIFIER=my_name) + + # Analyze a message + def process_message(self, message: dict) -> None: + for pattern_compiled, pattern_config in self.config.items(): + # Check if syslog id is presented in config and matches + syslog_id = pattern_config.get('syslog_id') + if syslog_id and message['SYSLOG_IDENTIFIER'] != syslog_id: + continue + if pattern_compiled.fullmatch(message['MESSAGE']): + # Add message to environment variables + pattern_config['pattern_script']['environment'][ + 'message'] = message['MESSAGE'] + # Run script + self.script_run( + pattern=pattern_config['pattern_raw'], + script_path=pattern_config['pattern_script']['path'], + script_env=pattern_config['pattern_script']['environment']) if __name__ == '__main__': @@ -76,6 +123,8 @@ if __name__ == '__main__': try: config_path = Path(args.config) config = json.loads(config_path.read_text()) + # Create an object for analazyng messages + analyzer = Analyzer(config) except Exception as err: print( f'Configuration file "{config_path}" does not exist or malformed: {err}' @@ -93,19 +142,6 @@ if __name__ == '__main__': p = select.poll() p.register(data, data.get_events()) - # Prepare compiled regex objects - patterns = {} - for name, event_config in config.items(): - pattern_raw = f'{event_config["pattern"]}' - pattern_compiled = re.compile(rf'{event_config["pattern"]}') - pattern_config = { - pattern_compiled: { - 'pattern_raw': pattern_raw, - 'pattern_script': event_config['script'] - } - } - patterns.update(pattern_config) - journal.send(f'Started with configuration: {config}', SYSLOG_IDENTIFIER=my_name) @@ -117,4 +153,8 @@ if __name__ == '__main__': pid = entry['_PID'] # Skip empty messages and messages from this process if message and pid != my_pid: - analyze_message(message, patterns) + try: + analyzer.process_message(entry) + except Exception as err: + journal.send(f'Unable to process message: {err}', + SYSLOG_IDENTIFIER=my_name) -- cgit v1.2.3 From 5f9d0ad5b258258654a9a897f35a6da8d9447670 Mon Sep 17 00:00:00 2001 From: Viacheslav Hletenko Date: Wed, 8 Jun 2022 10:12:47 +0000 Subject: event-handler: Change tagNode event-handler to node Before: set service event-handler Foo After: set service event-handler event Foo --- interface-definitions/service-event-handler.xml.in | 85 ++++++++++++---------- src/conf_mode/service_event_handler.py | 2 +- 2 files changed, 47 insertions(+), 40 deletions(-) (limited to 'interface-definitions') diff --git a/interface-definitions/service-event-handler.xml.in b/interface-definitions/service-event-handler.xml.in index ed6d41d1b..aef6bc1bc 100644 --- a/interface-definitions/service-event-handler.xml.in +++ b/interface-definitions/service-event-handler.xml.in @@ -2,62 +2,69 @@ - + - Event handler name + Service event handler - + - Logs filter settings + Event handler name - + - Match pattern (regex) - - - - - Identifier of a process in syslog (string) - - - - - - - Event handler script file - - - - - Script arguments - - - - - Script environment arguments + Logs filter settings - + - Environment value + Match pattern (regex) + + + + + Identifier of a process in syslog (string) - - + + - Path to the script - - - + Event handler script file - + + + + Script arguments + + + + + Script environment arguments + + + + + Environment value + + + + + + + Path to the script + + + + + + + - + - + diff --git a/src/conf_mode/service_event_handler.py b/src/conf_mode/service_event_handler.py index bb12da11d..5440d1056 100755 --- a/src/conf_mode/service_event_handler.py +++ b/src/conf_mode/service_event_handler.py @@ -34,7 +34,7 @@ def get_config(config=None): else: conf = Config() - base = ['service', 'event-handler'] + base = ['service', 'event-handler', 'event'] config = conf.get_config_dict(base, get_first_key=True, no_tag_node_value_mangle=True) -- cgit v1.2.3