troubadix 25.9.1__tar.gz → 25.10.7__tar.gz

{troubadix-25.9.1 → troubadix-25.10.7}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: troubadix
-Version: 25.9.1
+Version: 25.10.7
 Summary: A linting and QA check tool for NASL files
 License: GPL-3.0-or-later
+License-File: LICENSE
 Author: Greenbone
 Author-email: info@greenbone.net
 Requires-Python: >=3.10,<4.0
@@ -16,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: chardet (>=4,<6)
 Requires-Dist: charset-normalizer (>=3.2.0,<4.0.0)

{troubadix-25.9.1 → troubadix-25.10.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "troubadix"
-version = "25.9.1"
+version = "25.10.7"
 description = "A linting and QA check tool for NASL files"
 authors = ["Greenbone <info@greenbone.net>"]
 license = "GPL-3.0-or-later"
@@ -37,7 +37,7 @@ networkx = "^3.4.2"
 [tool.poetry.group.dev.dependencies]
 autohooks = ">=21.7.0"
 autohooks-plugin-black = ">=21.12.0"
-ruff = ">=0.5.6,<0.13.0"
+ruff = ">=0.5.6,<0.15.0"
 autohooks-plugin-ruff = ">=24.1,<26.0"
 
 [tool.black]

{troubadix-25.9.1 → troubadix-25.10.7}/tests/plugins/test_grammar.py

@@ -67,8 +67,9 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem: "
-            "# is prone to a security bypass vulnerabilities",
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: is prone to a security bypass vulnerabilities\n"
+            "- Full line: # is prone to a security bypass vulnerabilities",
             results[0].message,
         )
 
@@ -93,15 +94,17 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 2)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem: "
-            "# is prone to a security bypass vulnerabilities",
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: is prone to a security bypass vulnerabilities\n"
+            "- Full line: # is prone to a security bypass vulnerabilities",
             results[0].message,
         )
 
         self.assertIsInstance(results[1], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem: "
-            "# refer the Reference",
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: refer the Reference\n"
+            "- Full line: # refer the Reference",
             results[1].message,
         )
 
@@ -126,9 +129,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"summary", value:"Adobe Digital Edition is prone '
-            'a to denial of service (DoS) vulnerability.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: is prone a\n"
+            '- Full line: script_tag(name:"summary", value:"Adobe Digital '
+            'Edition is prone a to denial of service (DoS) vulnerability.");',
             results[0].message,
         )
 
@@ -153,9 +157,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"summary", value:"Splunk Enterprise is prone an '
-            'open redirect vulnerability.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: is prone an\n"
+            '- Full line: script_tag(name:"summary", value:"Splunk Enterprise '
+            'is prone an open redirect vulnerability.");',
             results[0].message,
         )
 
@@ -180,9 +185,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"vuldetect", value:"Sends multiple HTTP GET '
-            'request and checks the responses.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: multiple HTTP GET request\n"
+            '- Full line: script_tag(name:"vuldetect", value:"Sends multiple '
+            'HTTP GET request and checks the responses.");',
             results[0].message,
         )
 
@@ -206,9 +212,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"summary", value:"Foo Bar is prone to multiple '
-            'unknown vulnerability.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: multiple unknown vulnerability.\n"
+            '- Full line: script_tag(name:"summary", value:"Foo Bar is prone '
+            'to multiple unknown vulnerability.");',
             results[0].message,
         )
 
@@ -232,9 +239,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"summary", value:"Foo Bar is prone to a to a '
-            'remote denial-of-service vulnerability.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: to a to a\n"
+            '- Full line: script_tag(name:"summary", value:"Foo Bar is prone '
+            'to a to a remote denial-of-service vulnerability.");',
             results[0].message,
         )
 
@@ -258,9 +266,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"insight", value:"- CVE-2022-31702: Command '
-            'injection in the in the vRNI REST API.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: in the in the\n"
+            '- Full line: script_tag(name:"insight", value:"- CVE-2022-31702: '
+            'Command injection in the in the vRNI REST API.");',
             results[0].message,
         )
 
@@ -269,7 +278,7 @@ class CheckNewlinesTestCase(PluginTestCase):
         content = (
             '  script_tag(name:"cvss_base", value:"4.0");\n'
             '  script_tag(name:"solution", value:"Update to version to version '
-            ' 1.2.3 or later.");\n'
+            '1.2.3 or later.");\n'
             '  script_tag(name:"solution_type", value:"VendorFix");\n'
             '  script_tag(name:"solution", value:"meh");\n'
         )
@@ -284,9 +293,10 @@ class CheckNewlinesTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT/Include has the following grammar problem:   "
-            'script_tag(name:"solution", value:"Update to version to version '
-            ' 1.2.3 or later.");',
+            "VT/Include has the following grammar problem:\n"
+            "- Hit: to version to version\n"
+            '- Full line: script_tag(name:"solution", value:"Update to version '
+            'to version 1.2.3 or later.");',
             results[0].message,
         )
 
@@ -327,3 +337,21 @@ class CheckNewlinesTestCase(PluginTestCase):
         results = list(plugin.run())
 
         self.assertEqual(len(results), 0)
+
+    def test_grammar_fp2(self):
+        nasl_file = Path(__file__).parent / "test.nasl"
+        content = (
+            '  script_tag(name:"cvss_base", value:"4.0");\n'
+            '  script_tag(name:"insight", value:"Nadav Markus and Or Cohen of '
+            "Palo Alto Networks discovered\n"
+            '  script_tag(name:"solution_type", value:"VendorFix");\n'
+            '  script_tag(name:"solution", value:"meh");\n'
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=nasl_file, file_content=content
+        )
+        plugin = CheckGrammar(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 0)

{troubadix-25.9.1 → troubadix-25.10.7}/tests/plugins/test_script_add_preference_type.py

@@ -19,6 +19,7 @@ from pathlib import Path
 
 from troubadix.plugin import LinterError
 from troubadix.plugins.script_add_preference_type import (
+    VALID_TYPES,
     CheckScriptAddPreferenceType,
     ValidType,
 )
@@ -89,9 +90,57 @@ class CheckScriptAddPreferenceTypeTestCase(PluginTestCase):
         self.assertEqual(len(results), 1)
         self.assertIsInstance(results[0], LinterError)
         self.assertEqual(
-            "VT is using an invalid or misspelled string (invalid)"
-            " passed to the type parameter of "
-            "script_add_preference in "
-            f"'{add_pref}'",
+            "VT is using an invalid or misspelled type "
+            f"(invalid) in {add_pref} \n"
+            f"Allowed are: {sorted(VALID_TYPES)}",
+            results[0].message,
+        )
+
+    def test_invalid_with_parameters_order(self):
+        add_pref = (
+            'script_add_preference(name:"File or Directory Name", '
+            'type:"string", value:"/home", id:1);'
+        )
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"cvss_base", value:"4.0");\n'
+            '  script_name("Foo Bar");\n'
+            f"{add_pref}\n"
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckScriptAddPreferenceType(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            "VT is using an invalid or misspelled type "
+            f"(string) in {add_pref} \n"
+            f"Allowed are: {sorted(VALID_TYPES)}",
+            results[0].message,
+        )
+
+    def test_missing_type(self):
+        add_pref = 'script_add_preference(name:"File or Directory Name", value:"/home", id:1);'
+        path = Path("some/file.nasl")
+        content = (
+            '  script_tag(name:"cvss_base", value:"4.0");\n'
+            '  script_name("Foo Bar");\n'
+            f"{add_pref}\n"
+        )
+        fake_context = self.create_file_plugin_context(
+            nasl_file=path, file_content=content
+        )
+        plugin = CheckScriptAddPreferenceType(fake_context)
+
+        results = list(plugin.run())
+
+        self.assertEqual(len(results), 1)
+        self.assertIsInstance(results[0], LinterError)
+        self.assertEqual(
+            f"script_add_preference call is missing a 'type' parameter in '{add_pref}'",
             results[0].message,
         )

{troubadix-25.9.1 → troubadix-25.10.7}/troubadix/__version__.py

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

{troubadix-25.9.1 → troubadix-25.10.7}/troubadix/plugins/badwords.py

@@ -43,6 +43,7 @@ _IGNORE_FILES = [
     "http_func.inc",
     "misc_func.inc",
     "OpenVAS_detect.nasl",
+    "gb_greenbone_os_consolidation.nasl",
 ]
 
 EXCEPTIONS = [
@@ -79,6 +80,8 @@ EXCEPTIONS = [
     "OpenVAS / Greenbone Vulnerability Manager",
     "openvas_1808149858",
     "OSPD-OpenVAS",
+    "OPENVAS SCAN",
+    "openvas_scan",
     "evil.zip -> openvas.jsp",
     'url = "/openvas.jsp";',
     'if( "OpenVAS RCE Test" >< buf )',

{troubadix-25.9.1 → troubadix-25.10.7}/troubadix/plugins/grammar.py

@@ -110,6 +110,8 @@ exceptions = [
     # The default has been changed to prompt the user each time a website
     # requests a client certificate.
     TextCheck("a website requests a client certificate"),
+    # This is actually a given name
+    TextCheck("and Or Cohen"),
 ]
 
 
@@ -208,14 +210,23 @@ class CheckGrammar(FilePlugin):
 
         for match in pattern.finditer(self.context.file_content):
             if match:
+
+                # nb: No strip() here for so that the exclusions can be handled
+                # more strict with e.g. leading or trailing newlines.
+                full_line = match.group(0)
+
                 if handle_linguistic_checks(
-                    str(self.context.nasl_file), match.group(0), exceptions
+                    str(self.context.nasl_file), full_line, exceptions
                 ):
                     continue
 
+                stripped_line = full_line.strip()
+                stripped_hit = match.group(1).strip()
+
                 yield LinterError(
                     "VT/Include has the following grammar problem:"
-                    f" {match.group(0)}",
+                    f"\n- Hit: {stripped_hit}"
+                    f"\n- Full line: {stripped_line}",
                     file=self.context.nasl_file,
                     plugin=self.name,
                 )

{troubadix-25.9.1 → troubadix-25.10.7}/troubadix/plugins/script_add_preference_type.py

@@ -17,6 +17,7 @@
 
 # pylint: disable=fixme
 
+import re
 from enum import Enum
 from pathlib import Path
 from typing import Iterator
@@ -27,6 +28,10 @@ from troubadix.helper.patterns import (
 )
 from troubadix.plugin import FileContentPlugin, LinterError, LinterResult
 
+TYPE_PATTERN = re.compile(
+    r'type\s*:\s*(?P<quote>[\'"])(?P<type>[^\'"]+)(?P=quote)'
+)
+
 
 class ValidType(Enum):
     CHECKBOX = "checkbox"
@@ -36,6 +41,9 @@ class ValidType(Enum):
     ENTRY = "entry"
 
 
+VALID_TYPES = {t.value for t in ValidType}
+
+
 class CheckScriptAddPreferenceType(FileContentPlugin):
     name = "check_script_add_preference_type"
 
@@ -65,30 +73,43 @@ class CheckScriptAddPreferenceType(FileContentPlugin):
         if "script_add_preference" not in file_content:
             return
 
+        # Primary regex to capture all script_add_preference calls
         preferences_matches = _get_special_script_tag_pattern(
             name=SpecialScriptTag.ADD_PREFERENCE.value,
-            value=r'type\s*:\s*(?P<quote>[\'"])(?P<type>[^\'"]+)'
-            r"(?P=quote)\s*[^)]*",
         ).finditer(file_content)
 
+        # Secondary regex to extract type from the captured value (parameter list)
         for preferences_match in preferences_matches:
-            if preferences_match:
-                pref_type = preferences_match.group("type")
-                if pref_type not in [t.value for t in ValidType]:
-                    # nb: This exists since years and it is currently
-                    # unclear if we can change it so
-                    # we're excluding it here for now.
-                    if (
-                        "ssh_authorization_init.nasl" in nasl_file.name
-                        and pref_type == "sshlogin"
-                    ):
-                        continue
-
-                    yield LinterError(
-                        "VT is using an invalid or misspelled string "
-                        f"({pref_type}) passed to the type parameter of "
-                        "script_add_preference in "
-                        f"'{preferences_match.group(0)}'",
-                        file=nasl_file,
-                        plugin=self.name,
-                    )
+            params_content = preferences_match.group("value")
+            type_match = TYPE_PATTERN.search(params_content)
+
+            if not type_match:
+                yield LinterError(
+                    "script_add_preference call is missing a 'type' "
+                    f"parameter in '{preferences_match.group(0)}'",
+                    file=nasl_file,
+                    plugin=self.name,
+                )
+                continue
+
+            pref_type = type_match.group("type")
+            if pref_type in VALID_TYPES:
+                continue
+
+            # nb: This exists since years and it is currently
+            # unclear if we can change it so
+            # we're excluding it here for now.
+            if (
+                "ssh_authorization_init.nasl" in nasl_file.name
+                and pref_type == "sshlogin"
+            ):
+                continue
+
+            yield LinterError(
+                "VT is using an invalid or misspelled type "
+                f"({pref_type}) in "
+                f"{preferences_match.group(0)} \n"
+                f"Allowed are: {sorted(VALID_TYPES)}",
+                file=nasl_file,
+                plugin=self.name,
+            )