troubadix 25.10.7__py3-none-any.whl → 25.10.9__py3-none-any.whl

troubadix/__version__.py

@@ -2,4 +2,4 @@
 
 # THIS IS AN AUTOGENERATED FILE. DO NOT TOUCH!
 
-__version__ = "25.10.7"
+__version__ = "25.10.9"

troubadix/plugins/encoding.py

@@ -1,62 +1,78 @@
 # Copyright (C) 2022 Greenbone AG
-#
 # SPDX-License-Identifier: GPL-3.0-or-later
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, 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, see <http://www.gnu.org/licenses/>.
 
-import re
-from pathlib import Path
-from typing import Iterable, Iterator
+from typing import Iterator
 
-import charset_normalizer
+import magic
 
-from troubadix.plugin import LineContentPlugin, LinterError, LinterResult
+from troubadix.plugin import (
+    FilePlugin,
+    LinterError,
+    LinterResult,
+)
 
-# Only the ASCII and extended ASCII for now... # https://www.ascii-code.com/
-# CHAR_SET = r"[^\x00-\xFF]"
-# Temporary only check for chars in between 7f-9f, like in the old Feed-QA...
-INVALID_CHAR_PATTERN = re.compile(r"[\x7F-\x9F]")
+# OpenVAS decodes NASL files using ISO-8859-1 (Latin-1).
+# Files saved in other encodings (like UTF-8)
+# will be misinterpreted and cause errors or garbled text.
+# US-ASCII is also allowed since it's a subset of ISO-8859-1.
+ALLOWED_ENCODINGS = ["iso-8859-1", "us-ascii"]
 
-ALLOWED_ENCODINGS = ["ascii", "latin_1"]
 
+class CheckEncoding(FilePlugin):
+    """
+    Check if the encoding of the NASL file is ISO-8859-1 (Latin-1) encoded.
+    Finds UTF-8 multibyte sequences that are composed of individually valid Latin-1 bytes,
+    but result in garbled text.
+    """
 
-class CheckEncoding(LineContentPlugin):
     name = "check_encoding"
 
-    def check_lines(
-        self,
-        nasl_file: Path,
-        lines: Iterable[str],
-    ) -> Iterator[LinterResult]:
-        match = charset_normalizer.from_path(
-            nasl_file, threshold=0.4, cp_isolation=ALLOWED_ENCODINGS
-        ).best()
+    def run(self) -> Iterator[LinterResult]:
+        with open(self.context.nasl_file, "rb") as f:
+            raw = f.read()
 
-        if not match:
+        # Use magic to detect encoding
+        detected_encoding = magic.Magic(mime_encoding=True).from_buffer(raw)
+
+        if detected_encoding not in ALLOWED_ENCODINGS:
             yield LinterError(
-                f"VT uses a wrong encoding. "
-                f"Allowed encodings are {', '.join(ALLOWED_ENCODINGS)}.",
-                file=nasl_file,
+                f"Detected encoding '{detected_encoding.upper()}' is not Latin-1 compatible.",
+                file=self.context.nasl_file,
                 plugin=self.name,
             )
 
-        for index, line in enumerate(lines, 1):
-            encoding = INVALID_CHAR_PATTERN.search(line)
-            if encoding:
+        def has_utf8_multibyte(data: bytes) -> bool:
+            """
+            Function to detect UTF-8 multibyte sequences by checking the first two bytes.
+            UTF-8 multibyte sequences start with a lead byte followed by continuation bytes.
+
+            Lead byte ranges:
+            - 2-byte: 0xC2–0xDF (110xxxxx, excluding 0xC0–0xC1 to avoid overlongs)
+            - 3-byte: 0xE0–0xEF (1110xxxx)
+            - 4-byte: 0xF0–0xF4 (11110xxx)
+            These ranges are continuous, so we can check 0xC2–0xF4 as a single range.
+            11000010  C2  --  F4  11110111
+
+            Continuation bytes: 0x80–0xBF (10yyyyyy)
+            10000000  80  --  BF  10111111
+
+            Lead and continuation byte values are either not valid Latin-1 or special symbols
+            that are unlikely to be following each other in normal use.
+            """
+
+            for i in range(len(data) - 1):
+                first = data[i]
+                second = data[i + 1]
+                if 0xC2 <= first <= 0xF4 and 0x80 <= second <= 0xBF:
+                    return True
+            return False
+
+        lines = raw.split(b"\n")
+        for i, line_bytes in enumerate(lines, start=1):
+            if has_utf8_multibyte(line_bytes):
                 yield LinterError(
-                    f"Found invalid character in line: {index}",
-                    file=nasl_file,
+                    f"Likely UTF-8 multibyte sequence found in line {i}",
+                    file=self.context.nasl_file,
                     plugin=self.name,
-                    line=index,
+                    line=i,
                 )

troubadix/plugins/grammar.py

@@ -56,7 +56,7 @@ exceptions = [
         r"these\s+error\s+(messages|reports|conditions)", re.IGNORECASE
     ),
     PatternCheck(
-        r"these\s+file\s+(permissions|overwrites|names|includes|systems)",
+        r"these\s+file\s+(permissions|overwrites|names|includes|systems|formats)",
         re.IGNORECASE,
     ),
     # nb: Valid sentence

{troubadix-25.10.7.dist-info → troubadix-25.10.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: troubadix
-Version: 25.10.7
+Version: 25.10.9
 Summary: A linting and QA check tool for NASL files
 License: GPL-3.0-or-later
 License-File: LICENSE

{troubadix-25.10.7.dist-info → troubadix-25.10.9.dist-info}/RECORD

@@ -1,5 +1,5 @@
 troubadix/__init__.py,sha256=K7sIXXDrC7YRb7BvIpdQ6ZfG_QkT0qUH_wAlHROVRfM,716
-troubadix/__version__.py,sha256=URKTfluCYWyv6hpNgwKzTwfbDB-zbsbURt4HvY-BXM4,104
+troubadix/__version__.py,sha256=5vWilWzDGYBXmf8qR5PG3cr7jcf2aD3Xeu9CIBn01Ms,104
 troubadix/argparser.py,sha256=-H07Jhqh68_M4Mbjq9qJjTr3MShy_N2pxl2qHA6cfRU,7481
 troubadix/codespell/codespell.additions,sha256=SJPlIo8vEKEOTftY6ZBSXzcfyv6y9aFAXl9FdpcMxD0,561
 troubadix/codespell/codespell.exclude,sha256=W1dHEbKuXZbiLMRLhUPIzhCV1ptHqPLuaB6VsJLxn64,147965
@@ -27,10 +27,10 @@ troubadix/plugins/deprecated_functions.py,sha256=6e46woXd-3hUBnnuIXLlaqlcP6F7c99
 troubadix/plugins/double_end_points.py,sha256=1TLVc8HFYEKS870zaIoKmsAjBsRU9WZpaMKReRDUoLo,2509
 troubadix/plugins/duplicate_oid.py,sha256=lemYl3CUoOMFtRTLnlfjwPptnN51sQby3D9YjFtOv2Q,2652
 troubadix/plugins/duplicated_script_tags.py,sha256=UPBR2jbU15JLKJlVk1e2GFREH5Wj5Ax2yDFrmRKq74Y,3123
-troubadix/plugins/encoding.py,sha256=zNzqNpP39TUwOklnc8OJ3OIUelAN_hvnuBYoa3Pz764,2104
+troubadix/plugins/encoding.py,sha256=Ow_ZpyjtL2_nqhbukY_3EUhiR0agfSxMxJ4IcMSGsT4,2768
 troubadix/plugins/forking_nasl_functions.py,sha256=IUtCrTK_sGDx79jAPS8lF_aN8zSG2AkzfC6duTMvJOw,6069
 troubadix/plugins/get_kb_on_services.py,sha256=oFmcjiF7ZD3x5tEbJEoZNn80y1qUzNgeSZNsogSqaZ0,3401
-troubadix/plugins/grammar.py,sha256=hd5Qqamem9Iy64UMmdv5lEIfinS1vGDw_1CYNPmOsvg,10231
+troubadix/plugins/grammar.py,sha256=-53McZsKFuEavIS8-8CG7fUbW8VO3FuZv0PXenD42Bk,10239
 troubadix/plugins/http_links_in_tags.py,sha256=F4fm74M3CbmWOJoCyDdEO-bKQahFsHL6vs4ZynhHEkc,7325
 troubadix/plugins/if_statement_syntax.py,sha256=5BRJwCCghvZn1AfvYzmk8l9S7aRqbVaLHhSKod_Q9zw,1429
 troubadix/plugins/illegal_characters.py,sha256=B6q_RU85AxCjLry56Oc-RhMSpnJU8mTrxclRzi1FVFU,4406
@@ -108,8 +108,8 @@ troubadix/standalone_plugins/no_solution.py,sha256=p_-az9Igl4GH6HnhLLYbYlWIiEP64
 troubadix/standalone_plugins/util.py,sha256=JTXGmi-_BJouTNe6QzEosLlXUt9jKW-3fz4db05RJJw,696
 troubadix/standalone_plugins/version_updated.py,sha256=6YHF0OjL5NWszQdsSh7XzlSji1e6Uaqwu_Y6m3R0mvI,4203
 troubadix/troubadix.py,sha256=5__Jz3bYSrya4aG6RCBWxqnsDepXfwXZ3v0bjCzEFi0,6039
-troubadix-25.10.7.dist-info/METADATA,sha256=BXZnOZiPoSlgxZB2ig4wxRvucT7ehJ-0tSynVzr2np4,4536
-troubadix-25.10.7.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-troubadix-25.10.7.dist-info/entry_points.txt,sha256=ETEPBi4fKv3o7hzkzceX4838G6g5_5wRdEddYot8N6A,920
-troubadix-25.10.7.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-troubadix-25.10.7.dist-info/RECORD,,
+troubadix-25.10.9.dist-info/METADATA,sha256=vqH-RyAUMdTGfE_TiQ1WAsxQrsyXNm5LSD4xuf7l7G8,4536
+troubadix-25.10.9.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+troubadix-25.10.9.dist-info/entry_points.txt,sha256=ETEPBi4fKv3o7hzkzceX4838G6g5_5wRdEddYot8N6A,920
+troubadix-25.10.9.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+troubadix-25.10.9.dist-info/RECORD,,