troubadix 24.9.4__py3-none-any.whl → 24.10.1__py3-none-any.whl

troubadix/__version__.py

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

troubadix/plugins/__init__.py

@@ -18,6 +18,7 @@
 from typing import Iterable, List
 
 from troubadix.plugin import FilePlugin, FilesPlugin, Plugin
+from troubadix.plugins.spaces_before_dots import CheckSpacesBeforeDots
 
 from .badwords import CheckBadwords
 from .copyright_text import CheckCopyrightText
@@ -140,6 +141,7 @@ _FILE_PLUGINS = [
     CheckVTFilePermissions,
     CheckVTPlacement,
     CheckWrongSetGetKBCalls,
+    CheckSpacesBeforeDots,
 ]
 
 # plugins checking all files

troubadix/plugins/script_xref_url.py

@@ -64,7 +64,7 @@ class CheckScriptXrefUrl(FileContentPlugin):
         for match in matches:
             if match:
                 if match.group("value") not in ALLOWED_URLS and not url(
-                    match.group("value")
+                    match.group("value"), strict_query=False
                 ):
                     yield LinterError(
                         f"{match.group(0)}: Invalid URL value",

troubadix/plugins/spaces_before_dots.py

@@ -0,0 +1,130 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2024 Greenbone AG
+import re
+from collections.abc import Iterator
+from pathlib import Path
+
+from troubadix.helper import CURRENT_ENCODING
+from troubadix.helper.helper import is_ignore_file
+from troubadix.helper.patterns import (
+    ScriptTag,
+    get_script_tag_pattern,
+)
+from troubadix.plugin import (
+    FileContentPlugin,
+    LinterFix,
+    LinterResult,
+    LinterWarning,
+)
+
+TAGS = [
+    ScriptTag.SUMMARY,
+    ScriptTag.VULDETECT,
+    ScriptTag.INSIGHT,
+    ScriptTag.IMPACT,
+    ScriptTag.AFFECTED,
+    ScriptTag.SOLUTION,
+]
+
+# Regex pattern to match:
+# 1. A dot preceded and/or followed by any whitespace character (floating between words)
+# 2. A dot preceded by any whitespace character at the end of the string
+PATTERN = re.compile(r"\s+\.(\s|$)")
+IGNORE = [
+    # 21.04 and 22.04 are generated and should not be touched manually
+    "21.04/",
+    "22.04/",
+    # uses dots for beginning of entry in enumeration
+    "common/2008/debian/deb_246.nasl",
+    "common/2008/debian/deb_266.nasl",
+    "common/2008/freebsd/freebsd_5e92e8a2.nasl",
+    "common/2008/freebsd/freebsdsa_cpio.nasl",
+    "common/2008/freebsd/freebsdsa_cvs2.nasl",
+    "common/2009/osc_photoGallery_sql_injection.nasl",
+    "common/2009/secpod_novell_edir_mult_vuln_jul09_lin.nasl",
+    "common/2009/secpod_novell_edir_mult_vuln_jul09_win.nasl",
+    "common/2010/freebsd/freebsd_3a7c5fc4.nasl",
+    "common/2012/freebsd/freebsd_a4a809d8.nasl",
+    "common/2015/amazon/alas-2014-455.nasl",
+    "common/2015/gb_mozilla_firefox_mult_vuln01_mar15_macosx.nasl",
+    "common/2015/gb_mozilla_firefox_mult_vuln01_mar15_win.nasl",
+    "common/2015/oracle/ELSA-2009-1619.nasl",
+    "common/2015/oracle/ELSA-2011-0586.nasl",
+    "common/2016/gb_perl_privilege_escalation_vuln_win.nasl",
+    "common/2021/dropbear/gb_dropbear_ssh_filename_vuln_may20.nasl",
+    "common/2021/eclipse/gb_jetty_GHSA-v7ff-8wcx-gmc5_lin.nasl",
+    "common/2021/eclipse/gb_jetty_GHSA-v7ff-8wcx-gmc5_win.nasl",
+    "common/gsf/2009/mandriva/gb_mandriva_MDVSA_2008_140.nasl",
+    "common/gsf/2009/mandriva/gb_mandriva_MDVSA_2008_141.nasl",
+    "common/gsf/2010/mandriva/gb_mandriva_MDVA_2010_173.nasl",
+    "common/gsf/2010/mandriva/gb_mandriva_MDVSA_2010_155.nasl",
+    "common/gsf/2010/mandriva/gb_mandriva_MDVSA_2010_155_1.nasl",
+    "common/gsf/2010/mandriva/gb_mandriva_MDVSA_2010_167.nasl",
+    "common/gsf/2020/f5/gb_f5_big_ip_K11315080.nasl",
+    "common/gsf/2020/f5/gb_f5_big_iq_K11315080.nasl",
+    "common/2022/opensuse/gb_opensuse_2022_1548_1.nasl",
+    "common/2024/opensuse/gb_opensuse_2023_3247_1.nasl",
+    "common/attic/debian/deb_232_1.nasl",
+]
+
+
+class CheckSpacesBeforeDots(FileContentPlugin):
+    name = "check_spaces_before_dots"
+
+    def check_content(
+        self, nasl_file: Path, file_content: str
+    ) -> Iterator[LinterResult]:
+        """
+        This plugin checks for excess whitespace before a dot
+        in script_tags that have full sentence values
+        """
+        self.matches = []
+        if nasl_file.suffix == ".inc" or is_ignore_file(nasl_file, IGNORE):
+            return
+        for tag in TAGS:
+            pattern = get_script_tag_pattern(tag)
+            match = pattern.search(file_content)
+            if not match:
+                continue
+
+            value = match.group("value")
+            value_start = match.start("value")
+
+            for excess_match in PATTERN.finditer(value):
+                whitespace_pos = excess_match.start() + value_start
+                self.matches.append((whitespace_pos, excess_match.group()))
+                fullmatch = match.group()
+                yield LinterWarning(
+                    f"value of script_tag {match.group('name')} has at least"
+                    " one occurence of excess whitespace before a dot:"
+                    f"\n '{fullmatch}'",
+                    file=nasl_file,
+                    plugin=self.name,
+                )
+
+    def fix(self) -> Iterator[LinterResult]:
+
+        if not self.matches:
+            return
+
+        # Sort matches by position, descending order to avoid messing up indices during replacement
+        self.matches.sort(reverse=True)
+
+        file_content = self.context.file_content
+        for pos, match_str in self.matches:
+            # Replace the match by removing the excess whitespace before the dot
+            fixed_str = re.sub(r"\s+\.", ".", match_str)
+            file_content = (
+                file_content[:pos]
+                + fixed_str
+                + file_content[pos + len(match_str) :]
+            )
+
+        with open(self.context.nasl_file, "w", encoding=CURRENT_ENCODING) as f:
+            f.write(file_content)
+
+        yield LinterFix(
+            "Excess spaces were removed",
+            file=self.context.nasl_file,
+            plugin=self.name,
+        )

troubadix/standalone_plugins/deprecate_vts.py

@@ -2,12 +2,14 @@
 # SPDX-FileCopyrightText: 2024 Greenbone AG
 
 import re
-from argparse import ArgumentParser, Namespace
+from argparse import ArgumentParser, ArgumentTypeError, Namespace
 from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
 from typing import Iterable, Optional
 
+from pontos.terminal.terminal import ConsoleTerminal
+
 from troubadix.argparser import directory_type, file_type
 from troubadix.helper.patterns import (
     ScriptTag,
@@ -15,6 +17,7 @@ from troubadix.helper.patterns import (
     get_script_tag_pattern,
     get_special_script_tag_pattern,
 )
+from troubadix.troubadix import from_file
 
 
 class Deprecations(Enum):
@@ -34,6 +37,15 @@ class DeprecatedFile:
 KB_ITEMS_PATTERN = re.compile(r"set_kb_item\(.+\);")
 
 
+def existing_file_type(string: str) -> Path:
+    file_path = Path(string)
+    if not file_path.exists():
+        raise ArgumentTypeError(f'File "{string}" does not exist.')
+    if not file_path.is_file():
+        raise ArgumentTypeError(f'"{string}" is not a file.')
+    return file_path
+
+
 def update_summary(file: DeprecatedFile, deprecation_reason: str) -> str:
     """Update the summary of the nasl script by adding the information
     that the script has been deprecated, and if possible, the oid of
@@ -83,26 +95,18 @@ def get_files_from_path(dir_path: Path = None) -> list:
     return [file for file in dir_path.glob("**/*")]
 
 
-def filter_files(
-    files: list, filename_prefix: str = None
-) -> list[DeprecatedFile]:
-    """Filter the files based on a provided prefix and convert them into
+def parse_files(files: list) -> list[DeprecatedFile]:
+    """Convert filepaths into
     DeprecatedFile objects
 
     Args:
         files: a list of files to deprecate, should be .nasl VTs
-        filename_prefix: an optional prefix to filter only specific files
 
     Returns:
         List of DeprecatedFile objects
 
     """
     to_deprecate = []
-    if filename_prefix:
-        filename_filter = re.compile(rf"{filename_prefix}")
-        files[:] = [
-            file for file in files if re.match(filename_filter, file.name)
-        ]
 
     for file in files:
         with file.open("r", encoding="latin-1") as fh:
@@ -193,16 +197,6 @@ def parse_args(args: Iterable[str] = None) -> Namespace:
         required=True,
         help="Path where the deprecated files should be written to.",
     )
-    parser.add_argument(
-        "-p",
-        "--filename-prefix",
-        metavar="<filename_prefix>",
-        nargs="?",
-        default=None,
-        type=str,
-        help="The prefix of the files you would like to deprecate,"
-        "for example 'gb_rhsa_2021' to filter on the year",
-    )
     parser.add_argument(
         "-r",
         "--deprecation-reason",
@@ -214,16 +208,17 @@ def parse_args(args: Iterable[str] = None) -> Namespace:
         "been merged with another still active VT, 'duplicate': The VT has"
         "a still active duplicate, 'defunct': The VT is no longer "
         "functional.",
+        required=True,
     )
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument(
         "-f",
-        "--files",
-        metavar="<files>",
+        "--file",
+        metavar="<file>",
         nargs="+",
         default=None,
         type=file_type,
-        help="Files to deprecate",
+        help="File to deprecate",
     )
     group.add_argument(
         "-i",
@@ -231,20 +226,36 @@ def parse_args(args: Iterable[str] = None) -> Namespace:
         metavar="<input_path>",
         default=None,
         type=directory_type,
-        help="Path to the existing nasl script directory",
+        help="Path to a directory where all files should be deprecated.",
+    )
+    group.add_argument(
+        "--from-file",
+        metavar="<from_file>",
+        default=None,
+        type=existing_file_type,
+        help=(
+            "Path to a single file that contains a list of files "
+            "to be deprecated, separated by new lines."
+        ),
     )
     return parser.parse_args(args)
 
 
 def main():
     args = parse_args()
+    terminal = ConsoleTerminal()
     input_path = args.input_path if args.input_path else None
-    filename_prefix = args.filename_prefix
+    files = []
 
-    files = args.files or get_files_from_path(input_path)
-    filtered_files = filter_files(files, filename_prefix)
+    if input_path:
+        files = get_files_from_path(input_path)
+    elif args.from_file:
+        files = from_file(include_file=args.from_file, term=terminal)
+    elif args.file:
+        files = args.file
 
-    deprecate(args.output_path, filtered_files, args.deprecation_reason)
+    to_be_deprecated = parse_files(files)
+    deprecate(args.output_path, to_be_deprecated, args.deprecation_reason)
 
 
 if __name__ == "__main__":

{troubadix-24.9.4.dist-info → troubadix-24.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: troubadix
-Version: 24.9.4
+Version: 24.10.1
 Summary: A linting and QA check tool for NASL files
 Home-page: https://github.com/greenbone/troubadix
 License: GPL-3.0-or-later
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3
 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: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: chardet (>=4,<6)
 Requires-Dist: charset-normalizer (>=3.2.0,<4.0.0)
@@ -23,7 +24,7 @@ Requires-Dist: codespell (>=2.0.0,<3.0.0)
 Requires-Dist: gitpython (>=3.1.31,<4.0.0)
 Requires-Dist: pontos (>=22.7,<25.0)
 Requires-Dist: python-magic (>=0.4.25,<0.5.0)
-Requires-Dist: validators (==0.20.0)
+Requires-Dist: validators (>=0.34.0,<0.35.0)
 Project-URL: Repository, https://github.com/greenbone/troubadix
 Description-Content-Type: text/markdown
 

{troubadix-24.9.4.dist-info → troubadix-24.10.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 troubadix/__init__.py,sha256=K7sIXXDrC7YRb7BvIpdQ6ZfG_QkT0qUH_wAlHROVRfM,716
-troubadix/__version__.py,sha256=fCgh5yBoJNHBzdwMZ24n51N50H4g6MWpbLRDcZoIaZw,103
+troubadix/__version__.py,sha256=QzxNhvE2FNP2xdsM9j8IJSuyjqWoBaVmQ_l5mtbnUWw,104
 troubadix/argparser.py,sha256=YAo8cGJt0k2GMICXrDj3Z124GrM8oRwgNm2Bn3J_gYI,7001
 troubadix/codespell/codespell.additions,sha256=OaHe66OE0Yx4VTkhIeITZqB7_ERiv0fsDnpikGUgZ-Q,488
 troubadix/codespell/codespell.exclude,sha256=6HEOtHrMBBdm4E4794W4g1H9nmGLlYbgZpQiJzKio-A,139033
@@ -9,7 +9,7 @@ troubadix/helper/helper.py,sha256=GXapYLii2rLKwkX2ok31YoAdUSizBnyPjWz-aPP6HM8,31
 troubadix/helper/linguistic_exception_handler.py,sha256=Bq7ULjDdWTKUpFNTUX6XMPdD4s4v8eIjZPyqBe8VLws,6811
 troubadix/helper/patterns.py,sha256=_ifRnwHsPee9B0yRYSCsyFms4StWVWJq7I9YnQwToa8,9174
 troubadix/plugin.py,sha256=3fQPj3Qe_hgwHerlYE4hbdzYMzRU557NxJ-UwtE9mOI,3525
-troubadix/plugins/__init__.py,sha256=McIt4ZDPLmFxr0WMi8FmRoV-bDLXxSP-6JbrYKR1RHc,7413
+troubadix/plugins/__init__.py,sha256=V5fHMg2qVWIYKVZJqHKpzgrQ5x87Pz5u-h-CxOx7Dls,7511
 troubadix/plugins/badwords.py,sha256=C5Vuq6rzyeQkbEsg4t9ui9K05nQAh3Xy93sqV9K7aNw,4603
 troubadix/plugins/copyright_text.py,sha256=jYsLWmTbT_A78XQQxQFK-5kMMHkh3xdvlh7mEF2dZGU,3583
 troubadix/plugins/copyright_year.py,sha256=XzM9MHVzOXwNLwHpfuaWj8PUOmswr56SBVOLBdvxjd4,5478
@@ -52,11 +52,12 @@ troubadix/plugins/script_tag_whitespaces.py,sha256=2ZqiNufPIyr5Wmcuap3Wy8RXO_CHG
 troubadix/plugins/script_tags_mandatory.py,sha256=t9GiueHwCjWq-2jQszYNufWpfIKTLdUbbvXPyiw3HeY,2630
 troubadix/plugins/script_version_and_last_modification_tags.py,sha256=Yz9dQwrsRfIqXwPd8Re8aDu--SBjgufWOA6U7tW4JW4,7638
 troubadix/plugins/script_xref_form.py,sha256=5L1KPUHiKbe-71o-X0cUBT844XvIOsAJbB14gnYTod0,1848
-troubadix/plugins/script_xref_url.py,sha256=-IOzYTIINm8rZpI0CG94y_fdwJRW0FlRiGf3MnSj1O8,2875
+troubadix/plugins/script_xref_url.py,sha256=qKeRgcZEka4Xm0EYYSq9_J_y8jVn6lrLPYan2FljN4E,2895
 troubadix/plugins/security_messages.py,sha256=EPu3-YB0iP5_hfbQjrfvvTrQRiPgDjC85GTz3V-by0Q,4629
 troubadix/plugins/set_get_kb_calls.py,sha256=WGu1CKLjn3VhbDo33IJ4TtWQ-kz9gInkJskTqOSMM6k,3415
 troubadix/plugins/solution_text.py,sha256=4Gs84Qsyg-1iTDP7Y7o8Bo5AH4hKlwGPW0NfwMpx2fU,5852
 troubadix/plugins/solution_type.py,sha256=6wq7lj0bCL6tTaZ-d_aGKq6a_jVlCD73GltHJsJhmm8,2602
+troubadix/plugins/spaces_before_dots.py,sha256=83bVH4dxJPsNyd53kEX8fnDEge9R6kjAHdOnrDB7L9w,4852
 troubadix/plugins/spaces_in_filename.py,sha256=v8OqzzZSeI4_iXATHYzkf-HoAMxc_xb2Nj0HPAVevpk,611
 troubadix/plugins/spelling.py,sha256=3AW5sNtLL67OthKLaCH_y2HCVJ5YH_eyF9xjTJMIDG4,9593
 troubadix/plugins/tabs.py,sha256=7zXaTZe4cZoZvrLyqntVfTeNN_W3D8dfQl67QevXxtc,1319
@@ -86,14 +87,14 @@ troubadix/standalone_plugins/changed_packages/marker/dropped_architecture.py,sha
 troubadix/standalone_plugins/changed_packages/marker/marker.py,sha256=7uZXR2Ds_8soB_2wugCkOSz_3hoX03KMh2NAW0G5Dzg,1278
 troubadix/standalone_plugins/changed_packages/package.py,sha256=Pcr2tcwiPTzD3jB0iteqA7-TajL-dl5Onh1dvC_H9xk,2743
 troubadix/standalone_plugins/common.py,sha256=PkScV-lisNY4WyrzwjV3dK1DF26hJv5JXTcREblJ0v0,1028
-troubadix/standalone_plugins/deprecate_vts.py,sha256=kqWYfRO6Cr2E_zBnP3kJQoVznpRDcbIF6x6AiApYGBk,7661
+troubadix/standalone_plugins/deprecate_vts.py,sha256=WjhJb9YkUp_5TScE9wKI856tfi7ZZ6mBQQdrE-BqQE0,7889
 troubadix/standalone_plugins/file_extensions.py,sha256=QLQt02WIc4SWLDTKKnG8q2g-atC7Mgus-opuXf_SX1A,2630
 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=RlzVuXgFOvcjrRTOhiTYlmzV4vvcn7ntCz0lDTjePMU,4316
 troubadix/troubadix.py,sha256=foA7Loi67cCKieN3ea4s3QOfOWOkgwQVR1H-pNXtXn0,6041
-troubadix-24.9.4.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-troubadix-24.9.4.dist-info/METADATA,sha256=cy8Uc-BwHeiZuQABZkS1O_OmFEvFlSg7OG5pvAbvgLk,4357
-troubadix-24.9.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-troubadix-24.9.4.dist-info/entry_points.txt,sha256=LplOk4nzKrS4B8Jz0SPkQLPlIDesdraCO8Vp_eoycpc,737
-troubadix-24.9.4.dist-info/RECORD,,
+troubadix-24.10.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+troubadix-24.10.1.dist-info/METADATA,sha256=c7uJGlMtz-hbHkJJDpRsU-1kPAr8_QOjJvtyajMKK84,4417
+troubadix-24.10.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+troubadix-24.10.1.dist-info/entry_points.txt,sha256=LplOk4nzKrS4B8Jz0SPkQLPlIDesdraCO8Vp_eoycpc,737
+troubadix-24.10.1.dist-info/RECORD,,

{troubadix-24.9.4.dist-info → troubadix-24.10.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 1.9.1
 Root-Is-Purelib: true
 Tag: py3-none-any