troubadix 24.8.1__py3-none-any.whl → 24.8.2__py3-none-any.whl

troubadix/__version__.py

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

troubadix/argparser.py

@@ -19,9 +19,9 @@
 
 import sys
 from argparse import ArgumentParser, Namespace
+from collections.abc import Sequence
 from multiprocessing import cpu_count
 from pathlib import Path
-from typing import Iterable
 
 from pontos.terminal import Terminal
 
@@ -56,7 +56,7 @@ def check_cpu_count(number: str) -> int:
 
 def parse_args(
     terminal: Terminal,
-    args: Iterable[str] = None,
+    args: Sequence[str],
 ) -> Namespace:
     """Parsing args for troubadix
 

troubadix/plugin.py

@@ -16,9 +16,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from abc import ABC, abstractmethod
+from collections.abc import Iterable, Iterator
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Iterable, Iterator, Optional
+from typing import Optional
 
 from troubadix.helper import CURRENT_ENCODING
 
@@ -50,13 +51,13 @@ class FilePluginContext:
         self,
         *,
         root: Path,
-        nasl_file: Path = None,
+        nasl_file: Path,
     ) -> None:
         self.root = root
         self.nasl_file = nasl_file
 
-        self._file_content = None
-        self._lines = None
+        self._file_content: str | None = None
+        self._lines: list[str] | None = None
 
     @property
     def file_content(self) -> str:
@@ -67,7 +68,7 @@ class FilePluginContext:
         return self._file_content
 
     @property
-    def lines(self) -> Iterable[str]:
+    def lines(self) -> list[str]:
         if not self._lines:
             self._lines = self.file_content.splitlines()
         return self._lines
@@ -82,15 +83,14 @@ class FilesPluginContext:
 class Plugin(ABC):
     """A linter plugin"""
 
-    name: str = None
-    description: str = None
+    name: str
 
     @abstractmethod
     def run(self) -> Iterator[LinterResult]:
         pass
 
     def fix(self) -> Iterator[LinterResult]:
-        return []
+        return iter([])
 
 
 class FilesPlugin(Plugin):

troubadix/plugins/copyright_year.py

@@ -4,93 +4,149 @@
 
 import re
 from pathlib import Path
-from typing import Iterable, Iterator
+from typing import Iterator
 
 from troubadix.helper import is_ignore_file
-from troubadix.plugin import LineContentPlugin, LinterError, LinterResult
-
-_IGNORE_FILES = (
-    "sw_telnet_os_detection.nasl",
-    "gb_hp_comware_platform_detect_snmp.nasl",
-    "gb_hirschmann_telnet_detect.nasl",
+from troubadix.helper.patterns import (
+    ScriptTag,
+    SpecialScriptTag,
+    get_script_tag_pattern,
+    get_special_script_tag_pattern,
+)
+from troubadix.plugin import (
+    FileContentPlugin,
+    LinterError,
+    LinterResult,
 )
 
-_FULL_IGNORE_FILES = (
-    "test_version_func_inc.nasl",
-    "policy_control_template.nasl",
-    "template.nasl",
-    "test_ipv6_packet_forgery.nasl",
+_IGNORE_FILES = ()
+
+
+SPDX_OR_COPYRIGHT_PATTERN = re.compile(
+    r"(SPDX-FileCopyrightText:|Copyright \(C\))\s*(?P<year>\d{4})"
 )
 
 
-class CheckCopyrightYear(LineContentPlugin):
+def _generate_header_lines(file_content: str):
+    for line in file_content.splitlines():
+        if line.startswith("#"):
+            yield line
+        else:
+            break
+
+
+class CheckCopyrightYear(FileContentPlugin):
     """This steps checks if a VT contains a Copyright statement containing a
-    year not matching the year defined in the creation_date statement like
-    script_tag(name:"creation_date", value:"2017-
+    year not matching the year defined in the creation_date statement.
+
+    pre2008 script copyright are allowed to predate the creation_year
+
+    For scripts that contain multiple copyrights with different dates,
+    like gather-package-list.nasl, it is important that the newer one,
+    which is only valid as of a certain year, has information about
+    what it covers in the place where the year would normally be.
+    Then that line will be automatically ignored
+    without having to add it to the ignore list due to not matching the regex.
+    Example:
+        if creation year = 2008
+    ok:
+    # SPDX-FileCopyrightText: 2008 Tim Brown
+    # SPDX-FileCopyrightText: New detection methods / pattern / code since 2009 Greenbone AG
+    not ok / needs ignore entry:
+    # New NASL / detection code since 2018 Copyright (C) 2018 Greenbone AG
+
     """
 
     name = "check_copyright_year"
 
-    def check_lines(
-        self,
-        nasl_file: Path,
-        lines: Iterable[str],
+    def check_content(
+        self, nasl_file: Path, file_content: str
     ) -> Iterator[LinterResult]:
         if nasl_file.suffix == ".inc" or is_ignore_file(
-            nasl_file, _FULL_IGNORE_FILES
+            nasl_file, _IGNORE_FILES
         ):
             return
+        # extract creation year from script tag
+        creation_date_pattern = get_script_tag_pattern(ScriptTag.CREATION_DATE)
+        creation_date_match = creation_date_pattern.search(file_content)
+        if not creation_date_match:
+            yield LinterError(
+                "Missing creation_date statement in VT",
+                file=nasl_file,
+                plugin=self.name,
+            )
+            return
+        creation_year = int(creation_date_match.group("value")[:4])
 
-        creation_date = ""
-        creation_year = ""
-        copyrights = []
-
-        for i, line in enumerate(lines, 1):
-            if "creation_date" in line:
-                expre = re.search(r'value\s*:\s*"(.*)"', line)
-                if expre is not None and expre.group(1) is not None:
-                    creation_date = expre.group(1)
-                    expre = re.search(r"^([0-9]+)-", creation_date)
-                    if expre is not None and expre.group(1) is not None:
-                        creation_year = expre.group(1)
-
-            copyright_match = re.search(
-                r"((# |script_copyright.+)[Cc]opyright \([Cc]\)|"
-                r"# SPDX-FileCopyrightText:) ([0-9]+)",
-                line,
+        # extract year in value of script_copyright tag
+        script_copyright_pattern = get_special_script_tag_pattern(
+            SpecialScriptTag.COPYRIGHT
+        )
+        script_copyright_match = script_copyright_pattern.search(file_content)
+        if not script_copyright_match:
+            yield LinterError(
+                "Missing copyright tag in VT",
+                file=nasl_file,
+                plugin=self.name,
             )
-            if (
-                copyright_match is not None
-                and copyright_match.group(3) is not None
-                and not is_ignore_file(nasl_file, _IGNORE_FILES)
-            ):
-                copyrights.append((i, line, copyright_match.group(3)))
-
-        if not creation_year:
+            return
+        copyright_tag_value = script_copyright_match.group("value")
+        copyright_tag_match = SPDX_OR_COPYRIGHT_PATTERN.search(
+            copyright_tag_value
+        )
+        if not copyright_tag_match:
             yield LinterError(
-                "Missing creation_date statement in VT",
+                "Unable to extract year from script_copyright tag in VT",
                 file=nasl_file,
                 plugin=self.name,
             )
+            return
+        copyright_tag_year = int(copyright_tag_match.group("year"))
+
+        # list comprehension to collect copy right matches from header
+        header_lines = _generate_header_lines(file_content)
+        header_copyright_years = [
+            int(match.group("year"))
+            for line in header_lines
+            if (match := SPDX_OR_COPYRIGHT_PATTERN.search(line))
+        ]
 
-        # key is the line where the copyright is found, value the year found
-        # within that line
-        for nr, line, copyright_year in copyrights:
-            if copyright_year != creation_year:
+        if not header_copyright_years:
+            yield LinterError(
+                "VT header is missing a copyright text",
+                file=nasl_file,
+                plugin=self.name,
+            )
+
+        # check if the copyrights years match the creation year
+        # pre2008 VTs are allowed to have a copyright that predates the year of creation.
+        if copyright_tag_year != creation_year:
+            if "pre2008" in str(nasl_file):
+                if copyright_tag_year > creation_year:
+                    yield LinterError(
+                        "a pre2008 vt has a copyright tag year newer than the creation_year",
+                        file=nasl_file,
+                        plugin=self.name,
+                    )
+            else:
+                yield LinterError(
+                    "script_copyright tag does not match the creation year",
+                    file=nasl_file,
+                    plugin=self.name,
+                )
+        for copyright_year in header_copyright_years:
+            if creation_year != copyright_year:
                 if "pre2008" in str(nasl_file):
                     if copyright_year > creation_year:
                         yield LinterError(
-                            "VT contains a Copyright year not matching "
-                            f"the creation year {creation_year} at line {nr}",
+                            "a pre2008 vt has a copyright value in the fileheader"
+                            " newer than the creation_year",
                             file=nasl_file,
                             plugin=self.name,
-                            line=nr,
                         )
                 else:
                     yield LinterError(
-                        "VT contains a Copyright year not matching "
-                        f"the creation year {creation_year} at line {nr}",
+                        "a copyright in the fileheader does not match the creation year",
                         file=nasl_file,
                         plugin=self.name,
-                        line=nr,
                     )

troubadix/reporter.py

@@ -15,8 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from collections.abc import Iterable
 from pathlib import Path
-from typing import Iterable, List
 
 from pontos.terminal import Terminal
 
@@ -33,8 +33,8 @@ class Reporter:
         root: Path,
         *,
         fix: bool = False,
-        log_file: Path = None,
-        log_file_statistic: Path = None,
+        log_file: Path | None = None,
+        log_file_statistic: Path | None = None,
         statistic: bool = True,
         verbose: int = 0,
         ignore_warnings: bool = False,
@@ -78,7 +78,7 @@ class Reporter:
         self._log_append(f"\t\t{message}".replace("\n", "\n\t\t"))
 
     def _process_plugin_results(
-        self, plugin_name: str, plugin_results: List[LinterResult]
+        self, plugin_name: str, plugin_results: Iterable[LinterResult]
     ):
         """Process the results of a plugin: Print/Log results if
         verbosity/logging fits and count the results"""

troubadix/results.py

@@ -16,17 +16,15 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from collections import defaultdict
+from collections.abc import Iterator
 from pathlib import Path
-from typing import Dict, Iterable, Iterator
 
 from troubadix.plugin import LinterResult, LinterWarning
 
 
 class Results:
     def __init__(self, ignore_warnings: bool = False) -> None:
-        self.plugin_results: Dict[str, Iterable[LinterResult]] = defaultdict(
-            list
-        )
+        self.plugin_results: dict[str, list[LinterResult]] = defaultdict(list)
         self.has_plugin_results = False
         self._ignore_warnings = ignore_warnings
 

troubadix/runner.py

@@ -17,9 +17,9 @@
 
 import datetime
 import signal
+from collections.abc import Iterable
 from multiprocessing import Pool
 from pathlib import Path
-from typing import Iterable
 
 from troubadix.helper.patterns import (
     init_script_tag_patterns,
@@ -49,11 +49,11 @@ class Runner:
         reporter: Reporter,
         *,
         root: Path,
-        excluded_plugins: Iterable[str] = None,
-        included_plugins: Iterable[str] = None,
+        excluded_plugins: Iterable[str] | None = None,
+        included_plugins: Iterable[str] | None = None,
         fix: bool = False,
         ignore_warnings: bool = False,
-    ) -> bool:
+    ) -> None:
         # plugins initialization
         self.plugins = StandardPlugins(excluded_plugins, included_plugins)
 

troubadix/troubadix.py

@@ -18,8 +18,8 @@
 """ Main module for troubadix """
 
 import sys
+from collections.abc import Iterable
 from pathlib import Path
-from typing import Iterable, List, Tuple
 
 from pontos.terminal import Terminal
 from pontos.terminal.terminal import ConsoleTerminal
@@ -35,7 +35,7 @@ def generate_file_list(
     dirs: Iterable[Path],
     exclude_patterns: Iterable[str],
     include_patterns: Iterable[str],
-) -> List[Path]:
+) -> list[Path]:
     """Generates a files list under respect of several given arguments
 
     Arguments:
@@ -48,7 +48,7 @@ def generate_file_list(
 
     Returns
     List of Path objects"""
-    files: List[Path] = []
+    files: list[Path] = []
     for directory in dirs:
         for pattern in include_patterns:
             files.extend(directory.glob(pattern))
@@ -64,10 +64,10 @@ def generate_file_list(
 
 def generate_patterns(
     terminal: ConsoleTerminal,
-    include_patterns: List[str],
-    exclude_patterns: List[str],
+    include_patterns: list[str],
+    exclude_patterns: list[str],
     non_recursive: bool,
-) -> Tuple[List[str], List[str]]:
+) -> tuple[list[str], list[str]]:
     """Generates the include and exclude patterns
 
     Arguments:

{troubadix-24.8.1.dist-info → troubadix-24.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: troubadix
-Version: 24.8.1
+Version: 24.8.2
 Summary: A linting and QA check tool for NASL files
 Home-page: https://github.com/greenbone/troubadix
 License: GPL-3.0-or-later

{troubadix-24.8.1.dist-info → troubadix-24.8.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 troubadix/__init__.py,sha256=K7sIXXDrC7YRb7BvIpdQ6ZfG_QkT0qUH_wAlHROVRfM,716
-troubadix/__version__.py,sha256=ifB9RDBM7-2V2HRMId0VsqTT6_vzgQuniDkvyk44r5A,103
-troubadix/argparser.py,sha256=r9IkiYkd_8BqFGUEkhpawnW5DHo4hIciHd0dptToBjk,6999
+troubadix/__version__.py,sha256=A-mzx324wDkyalOPGij0nXdX-gqSaA5FP9hqVUjLc9E,103
+troubadix/argparser.py,sha256=YAo8cGJt0k2GMICXrDj3Z124GrM8oRwgNm2Bn3J_gYI,7001
 troubadix/codespell/codespell.additions,sha256=9hUrzjJF4Q8T5rVLx8CQa01oICvmsjzE6sCPjVRDOEU,418
 troubadix/codespell/codespell.exclude,sha256=qALEzLglEbPwcTRwGcobM_MTJzZyJekYRdJY3ws5yeM,138030
 troubadix/codespell/codespell.ignore,sha256=-naAh453UCGeT-oGWoJ5QNuUrDGP0aRd8WrOuU6oETI,1175
@@ -8,11 +8,11 @@ troubadix/helper/__init__.py,sha256=tp2fPLzwGEA_2eiJbvuePiY6rjYSFxx7VUsCV4fSwvw,
 troubadix/helper/helper.py,sha256=GXapYLii2rLKwkX2ok31YoAdUSizBnyPjWz-aPP6HM8,3105
 troubadix/helper/linguistic_exception_handler.py,sha256=Bq7ULjDdWTKUpFNTUX6XMPdD4s4v8eIjZPyqBe8VLws,6811
 troubadix/helper/patterns.py,sha256=_ifRnwHsPee9B0yRYSCsyFms4StWVWJq7I9YnQwToa8,9174
-troubadix/plugin.py,sha256=JVx4Vyop3pkN5xyNK6Vk6wGyd29BXZCa24GNRk2gen4,3508
+troubadix/plugin.py,sha256=3fQPj3Qe_hgwHerlYE4hbdzYMzRU557NxJ-UwtE9mOI,3525
 troubadix/plugins/__init__.py,sha256=McIt4ZDPLmFxr0WMi8FmRoV-bDLXxSP-6JbrYKR1RHc,7413
 troubadix/plugins/badwords.py,sha256=C5Vuq6rzyeQkbEsg4t9ui9K05nQAh3Xy93sqV9K7aNw,4603
 troubadix/plugins/copyright_text.py,sha256=jYsLWmTbT_A78XQQxQFK-5kMMHkh3xdvlh7mEF2dZGU,3583
-troubadix/plugins/copyright_year.py,sha256=n6-1hKV58Aj9iPTsaUqVxeoFUVZT3Xgc-YLdqNkM2_g,3334
+troubadix/plugins/copyright_year.py,sha256=XzM9MHVzOXwNLwHpfuaWj8PUOmswr56SBVOLBdvxjd4,5478
 troubadix/plugins/creation_date.py,sha256=61vF871P2qdB0TE8g__BwgHHbs4ffxVmUmM3YAiy9GE,3357
 troubadix/plugins/cve_format.py,sha256=Ue6b9RzuQZWOdBd6y5ruqdEq2zyRb2_FSUQScnjHOUQ,3400
 troubadix/plugins/cvss_format.py,sha256=GrZfZxkxSh9OVixmBBnHQ4NzF9nN2tCK1vepz_-U60g,2309
@@ -69,9 +69,9 @@ troubadix/plugins/variable_assigned_in_if.py,sha256=NNz8iuzyQ4rSM6My4WYC1s5TABQq
 troubadix/plugins/variable_redefinition_in_foreach.py,sha256=SfaA70TkpD9dsvNbhwJEA3eLAHWvj4YwksN-qeBMowg,2470
 troubadix/plugins/vt_file_permissions.py,sha256=-8rOUD0NpRwB0Ec5oQCcVpDVAaZqsUopqpGPB1To6fY,1521
 troubadix/plugins/vt_placement.py,sha256=m9AaswV2w6Qk_EaG_KuO82OUzIAyIBpXoTW0T4Ya76Y,2800
-troubadix/reporter.py,sha256=wY0dml545irS8hUnOGChUjiTlX0doi29w25wW-GQofs,9267
-troubadix/results.py,sha256=n1zcRaMvqT6vqar-W1nbAozBWUiD8-80kliddorlJRo,2632
-troubadix/runner.py,sha256=qDbwBfS1HsgclGHSJNqJ-C4EOPNnN5jKbW5M5o9jAjU,5172
+troubadix/reporter.py,sha256=ljZReqAHY8I4C0ROB-A7bBB5xsksG_y7bEgPFzLn_A8,9288
+troubadix/results.py,sha256=PAe3n0A99XXNYeP8gLliuDFt0V9J5a7oPun_bKU4LG4,2599
+troubadix/runner.py,sha256=RHyZe7YMBzJpCGBVfBUg2BMkVi13CmI9u0DVG2z4518,5195
 troubadix/standalone_plugins/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
 troubadix/standalone_plugins/allowed_rev_diff.py,sha256=5Zc8xTZlkMOPVNRdxNkosFFtwaQ6J8RiJYzaYXEuN40,4145
 troubadix/standalone_plugins/changed_cves.py,sha256=nEWwDa33QXekvpwcmnGMrdPHrJISz9p9j6lX09teDlk,2921
@@ -91,9 +91,9 @@ troubadix/standalone_plugins/file_extensions.py,sha256=3lEf73573RaTWgWZgiw8FFICK
 troubadix/standalone_plugins/last_modification.py,sha256=oYzQq7xV3YzSvi6ZtuHuupXsJwBtO93tKfbwaIeqiJI,4616
 troubadix/standalone_plugins/no_solution.py,sha256=81r20kP8otRob2NTaCea-sgVRIM6ARvhddFdibsG6Ao,8877
 troubadix/standalone_plugins/version_updated.py,sha256=dIGj81rbluyNjINn9kA1yPY2hUo6fqbNa-kg0Zi9Clc,4263
-troubadix/troubadix.py,sha256=L3Iacrq2uQx8wrmsD4nCFjJDeRDMRWtgSgHLWdP8gJE,6045
-troubadix-24.8.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-troubadix-24.8.1.dist-info/METADATA,sha256=quph962qeQCDehETHRvuRzv3HoLbdzATp82_wRJ9_zg,3916
-troubadix-24.8.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-troubadix-24.8.1.dist-info/entry_points.txt,sha256=LplOk4nzKrS4B8Jz0SPkQLPlIDesdraCO8Vp_eoycpc,737
-troubadix-24.8.1.dist-info/RECORD,,
+troubadix/troubadix.py,sha256=foA7Loi67cCKieN3ea4s3QOfOWOkgwQVR1H-pNXtXn0,6041
+troubadix-24.8.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+troubadix-24.8.2.dist-info/METADATA,sha256=IKjBeLHS1kSuOgk0STxyW7PGoxPRxR_npN9CMNvM3LE,3916
+troubadix-24.8.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+troubadix-24.8.2.dist-info/entry_points.txt,sha256=LplOk4nzKrS4B8Jz0SPkQLPlIDesdraCO8Vp_eoycpc,737
+troubadix-24.8.2.dist-info/RECORD,,