from modules.nfregex.nftables import FiregexTables from utils import run_func from modules.nfregex.models import Service, Regex import os import asyncio import traceback from utils import DEBUG from fastapi import HTTPException from utils import nicenessify nft = FiregexTables() MODULE = "nfregex" async def test_regex_validity(regex: str) -> bool: proxy_binary_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),"../cppregex") process = await asyncio.create_subprocess_exec( proxy_binary_path, stdout=asyncio.subprocess.PIPE, stdin=asyncio.subprocess.DEVNULL, env={"FIREGEX_TEST_REGEX": regex}, ) await process.wait() if process.returncode != 0: message = (await process.stdout.read()).decode() return False, message return True, "ok" class RegexFilter: def __init__( self, regex, is_case_sensitive=True, input_mode=False, output_mode=False, blocked_packets=0, id=None, update_func = None ): self.regex = regex self.is_case_sensitive = is_case_sensitive if input_mode == output_mode: input_mode = output_mode = True # (False, False) == (True, True) self.input_mode = input_mode self.output_mode = output_mode self.blocked = blocked_packets self.id = id self.update_func = update_func self.compiled_regex = self.compile() @classmethod def from_regex(cls, regex:Regex, update_func = None): return cls( id=regex.id, regex=regex.regex, is_case_sensitive=regex.is_case_sensitive, blocked_packets=regex.blocked_packets, input_mode = regex.mode in ["C","B"], output_mode=regex.mode in ["S","B"], update_func = update_func ) def compile(self): if isinstance(self.regex, str): self.regex = self.regex.encode() if not isinstance(self.regex, bytes): raise Exception("Invalid Regex Paramether") case_sensitive = "1" if self.is_case_sensitive else "0" if self.input_mode: yield case_sensitive + "C" + self.regex.hex() if self.output_mode: yield case_sensitive + "S" + self.regex.hex() async def update(self): if self.update_func: await run_func(self.update_func, self) class FiregexInterceptor: def __init__(self): self.srv:Service self.filter_map_lock:asyncio.Lock self.filter_map: dict[str, RegexFilter] self.regex_filters: set[RegexFilter] self.update_config_lock:asyncio.Lock self.process:asyncio.subprocess.Process self.update_task: asyncio.Task self.ack_arrived = False self.ack_status = None self.ack_fail_what = "Queue response timed-out" self.ack_lock = asyncio.Lock() self.watchdog_task: asyncio.Task = None self.exit_callback = None self.stopped = False @classmethod async def start(cls, srv: Service, on_exit=None): self = cls() self.srv = srv self.exit_callback = on_exit self.filter_map_lock = asyncio.Lock() self.update_config_lock = asyncio.Lock() queue_range = await self._start_binary() self.update_task = asyncio.create_task(self.update_blocked()) self.watchdog_task = asyncio.create_task(self._watch_process()) nft.add(self.srv, queue_range) if not self.ack_lock.locked(): await self.ack_lock.acquire() return self async def _start_binary(self): proxy_binary_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),"../cppregex") self.process = await asyncio.create_subprocess_exec( proxy_binary_path, stdout=asyncio.subprocess.PIPE, stdin=asyncio.subprocess.PIPE, env=dict(os.environ, **{ "MATCH_MODE": "stream" if self.srv.proto == "tcp" else "block", "NTHREADS": os.getenv("NTHREADS","1"), "FIREGEX_NFQUEUE_FAIL_OPEN": "1" if self.srv.fail_open else "0", }), ) nicenessify(-10, self.process.pid) line_fut = self.process.stdout.readuntil() try: line_fut = await asyncio.wait_for(line_fut, timeout=3) except asyncio.TimeoutError: self.process.kill() raise Exception("Invalid binary output") line = line_fut.decode() if line.startswith("QUEUE "): params = line.split() return (int(params[1]), int(params[1])) else: self.process.kill() raise Exception("Invalid binary output") async def update_blocked(self): try: while True: line = (await self.process.stdout.readuntil()).decode() if DEBUG: print(line) if line.startswith("BLOCKED "): regex_id = line.split()[1] async with self.filter_map_lock: if regex_id in self.filter_map: self.filter_map[regex_id].blocked+=1 await self.filter_map[regex_id].update() if line.startswith("ACK "): self.ack_arrived = True self.ack_status = line.split()[1].upper() == "OK" if not self.ack_status: self.ack_fail_what = " ".join(line.split()[2:]) self.ack_lock.release() except asyncio.CancelledError: pass except asyncio.IncompleteReadError: pass except Exception: traceback.print_exc() async def _watch_process(self): """Detects an unexpected death of the interceptor binary. The nftables rules are installed independently of this process and survive it, so a crashed interceptor leaves the service completely unfiltered (silently accepted when the service is fail_open, dropped otherwise) while the UI keeps reporting it as active. Nothing used to notice: the stdout reader just saw EOF and returned. """ try: returncode = await self.process.wait() except asyncio.CancelledError: return if self.stopped: return # We killed it ourselves print(f"[error] [{MODULE}] The interceptor of service {self.srv.id} exited unexpectedly with code {returncode}") if self.exit_callback: try: await run_func(self.exit_callback, returncode) except asyncio.CancelledError: raise except Exception: traceback.print_exc() async def stop(self, expected: bool = True): """Tears the interceptor down. `expected` tells the watchdog whether this shutdown was asked for: an internal failure passes False so that the crash is still reported and the service can be recovered, instead of looking like a clean stop. """ self.stopped = expected # The watchdog itself calls stop() through the exit callback: cancelling # the running task from inside would abort the recovery. if self.watchdog_task and self.watchdog_task is not asyncio.current_task(): self.watchdog_task.cancel() self.update_task.cancel() if self.process and self.process.returncode is None: self.process.kill() async def _update_config(self, filters_codes): async with self.update_config_lock: self.process.stdin.write((" ".join(filters_codes)+"\n").encode()) await self.process.stdin.drain() try: async with asyncio.timeout(3): await self.ack_lock.acquire() except TimeoutError: self.ack_fail_what = "Queue response timed-out" if not self.ack_arrived or not self.ack_status: await self.stop() raise HTTPException(status_code=500, detail=f"NFQ error: {self.ack_fail_what}") async def reload(self, filters:list[RegexFilter]): async with self.filter_map_lock: self.filter_map = self.compile_filters(filters) filters_codes = self.get_filter_codes() await self._update_config(filters_codes) def get_filter_codes(self): filters_codes = list(self.filter_map.keys()) filters_codes.sort(key=lambda a: self.filter_map[a].blocked, reverse=True) return filters_codes def compile_filters(self, filters:list[RegexFilter]): res = {} for filter_obj in filters: try: raw_filters = filter_obj.compile() for filter in raw_filters: res[filter] = filter_obj except Exception: pass return res