-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
syslog-ng: add webhook() and webhook-json() sources
Signed-off-by: László Várady <laszlo.varady@axoflow.com>
- Loading branch information
Showing
9 changed files
with
278 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| tornado==6.4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| from .source import HTTPSource | ||
|
|
||
| __all__ = [ | ||
| "HTTPSource" | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| ############################################################################# | ||
| # Copyright (c) 2024 László Várady | ||
| # | ||
| # This program is free software; you can redistribute it and/or modify it | ||
| # under the terms of the GNU General Public License version 2 as published | ||
| # by the Free Software Foundation, or (at your option) any later version. | ||
| # | ||
| # 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, write to the Free Software | ||
| # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
| # | ||
| # As an additional exemption you are allowed to compile & link against the | ||
| # OpenSSL libraries as published by the OpenSSL project. See the file | ||
| # COPYING for details. | ||
| # | ||
| ############################################################################# | ||
|
|
||
| block source webhook( | ||
| port("") | ||
| auth_token("") | ||
| tls_key_file("") | ||
| tls_cert_file("") | ||
| ... | ||
| ) | ||
| { | ||
| python( | ||
| class("syslogng.modules.http.HTTPSource") | ||
| options( | ||
| "port" => "`port`" | ||
| "auth_token" => "`auth_token`" | ||
| "tls_key_file" => "`tls_key_file`" | ||
| "tls_cert_file" => "`tls_cert_file`" | ||
| ) | ||
| `__VARARGS__` | ||
| ); | ||
| }; | ||
|
|
||
| block source webhook-json( | ||
| port("") | ||
| auth_token("") | ||
| tls_key_file("") | ||
| tls_cert_file("") | ||
| prefix("") | ||
| ... | ||
| ) | ||
| { | ||
| channel { | ||
| source { | ||
| webhook( | ||
| port("`port`") auth_token("`auth_token`") | ||
| tls_key_file("`tls_key_file`") tls_cert_file("`tls_cert_file`") | ||
| `__VARARGS__` | ||
| ); | ||
| }; | ||
|
|
||
| parser { | ||
| json-parser(prefix("`prefix`")); | ||
| }; | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| ############################################################################# | ||
| # Copyright (c) 2024 László Várady | ||
| # | ||
| # This program is free software; you can redistribute it and/or modify it | ||
| # under the terms of the GNU General Public License version 2 as published | ||
| # by the Free Software Foundation, or (at your option) any later version. | ||
| # | ||
| # 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, write to the Free Software | ||
| # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | ||
| # | ||
| # As an additional exemption you are allowed to compile & link against the | ||
| # OpenSSL libraries as published by the OpenSSL project. See the file | ||
| # COPYING for details. | ||
| # | ||
| ############################################################################# | ||
|
|
||
| from syslogng import LogSource, LogMessage | ||
|
|
||
| import logging | ||
| import asyncio | ||
| import threading | ||
| import tornado | ||
| import ssl | ||
| import signal | ||
| from typing import Any | ||
|
|
||
| signal.signal(signal.SIGINT, signal.SIG_IGN) | ||
| signal.signal(signal.SIGTERM, signal.SIG_IGN) | ||
|
|
||
| class Handler(tornado.web.RequestHandler): | ||
| def initialize(self, source) -> None: | ||
| self.source = source | ||
|
|
||
| @tornado.web.authenticated | ||
| async def post(self) -> None: | ||
| # racy, but the client should retry | ||
| if self.source.suspended.is_set(): | ||
| self.set_status(503) | ||
| await self.finish({"status": "flow-controlled"}) | ||
| return | ||
|
|
||
| self.source.post_message(LogMessage(self.request.body)) | ||
| await self.finish({"status": "received"}) | ||
|
|
||
| def set_default_headers(self) -> None: | ||
| self.set_header("Server", "syslog-ng"); | ||
|
|
||
| def get_current_user(self): | ||
| if not self.source.auth_token: | ||
| return True | ||
|
|
||
| token = self.request.headers.get("Authorization", "").split(" ") | ||
| if len(token) != 2: | ||
| return False | ||
|
|
||
| token = token[1] | ||
| return self.source.auth_token == token | ||
|
|
||
| def write_error(self, status_code: int, **kwargs: Any) -> None: | ||
| self.set_status(status_code) | ||
|
|
||
| class HTTPSource(LogSource): | ||
| def init(self, options: dict[str, Any]) -> bool: | ||
| self.logger = logging.getLogger("http") | ||
| self.set_transport_name("http") | ||
| if not self.init_options(options): | ||
| return False | ||
|
|
||
| self.ssl_ctx = None | ||
| if self.tls_key_file: | ||
| self.ssl_ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) | ||
| self.ssl_ctx.load_cert_chain(self.tls_cert_file, self.tls_key_file) | ||
|
|
||
| if not self.port: | ||
| self.port = 443 if self.tls_key_file else 80 | ||
|
|
||
| self.port = int(self.port) | ||
|
|
||
| self.suspended = threading.Event() | ||
| self.event_loop = asyncio.new_event_loop() | ||
| self.request_exit = asyncio.Event() | ||
| self.app = tornado.web.Application( | ||
| [ | ||
| (r"/.*", Handler, {"source": self}), | ||
| ], | ||
| log_function=self.log_access, | ||
| autoreload=False, | ||
| compress_response=False, | ||
| ) | ||
| self.server = None | ||
|
|
||
| return True | ||
|
|
||
| async def runServer(self) -> None: | ||
| self.logger.info(f"HTTP(S) server started on port {self.port}") | ||
| self.server = self.app.listen(self.port, decompress_request=True, ssl_options=self.ssl_ctx) | ||
| await self.request_exit.wait() | ||
|
|
||
| self.server.stop() | ||
| await self.server.close_all_connections() | ||
|
|
||
| async def stopServer(self) -> None: | ||
| self.request_exit.set() | ||
|
|
||
| def deinit(self) -> None: | ||
| pass | ||
|
|
||
| def run(self) -> None: | ||
| self.event_loop.run_until_complete(self.runServer()) | ||
|
|
||
| def suspend(self) -> None: | ||
| self.suspended.set() | ||
|
|
||
| def wakeup(self) -> None: | ||
| self.suspended.clear() | ||
|
|
||
| def request_exit(self) -> None : | ||
| asyncio.run_coroutine_threadsafe(self.stopServer(), self.event_loop) | ||
| pass | ||
|
|
||
| def log_access(self, req: tornado.web.RequestHandler): | ||
| self.logger.debug(f"{req.get_status()} {req._request_summary()}") | ||
|
|
||
| def init_options(self, options: dict[str, Any]) -> bool: | ||
| try: | ||
| self.port = options.get("port") | ||
| self.auth_token = options.get("auth_token") | ||
| self.tls_key_file = options.get("tls_key_file") | ||
| self.tls_cert_file = options.get("tls_cert_file") | ||
| return True | ||
| except KeyError as e: | ||
| self.logger.error(f"Missing option '{e.args[0]}'") | ||
| return False |