troubadix 24.7.1__py3-none-any.whl → 24.7.3__py3-none-any.whl

troubadix/__version__.py

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

troubadix/standalone_plugins/deprecate_vts.py

@@ -0,0 +1,251 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2024 Greenbone AG
+
+import re
+from argparse import ArgumentParser, Namespace
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+from typing import Iterable, Optional
+
+from troubadix.argparser import file_type, directory_type
+from troubadix.helper.patterns import (
+    get_special_script_tag_pattern,
+    get_script_tag_pattern,
+    ScriptTag,
+    SpecialScriptTag,
+)
+
+
+class Deprecations(Enum):
+    NOTUS = "and replaced by a Notus scanner based one."
+    MERGED = "because it has been merged into a different VT."
+    DEFUNCT = "and is therefore no longer functional."
+    DUPLICATE = "as a duplicate."
+
+
+@dataclass
+class DeprecatedFile:
+    name: str
+    full_path: Path
+    content: str
+
+
+KB_ITEMS_PATTERN = re.compile(r"set_kb_item\(.+\);")
+
+
+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
+    the new notus script replacing it.
+
+    Args:
+        file: DeprecatedFile object containing the content of the VT
+        deprecation_reason: The reason this VT is being deprecated,
+            from a list of options.
+
+    Returns:
+        The updated content of the file
+    """
+    old_summary = _get_summary(file.content)
+    if not old_summary:
+        print(f"No summary in: {file.name}")
+        return file.content
+
+    deprecate_text = (
+        f"Note: This VT has been deprecated "
+        f"{Deprecations[deprecation_reason].value}"
+    )
+
+    new_summary = old_summary + "\n" + deprecate_text
+    file.content = file.content.replace(old_summary, new_summary)
+
+    return file.content
+
+
+def _finalize_content(content: str) -> str:
+    """Update the content field of the nasl script by adding the
+    deprecated tag and removing the extra content."""
+    content_to_keep = content.split("exit(0);")[0]
+    return content_to_keep + (
+        'script_tag(name:"deprecated", value:TRUE);'
+        "\n\nexit(0);\n}\n\nexit(66);\n"
+    )
+
+
+def get_files_from_path(dir_path: Path = None) -> list:
+    """Get a list of files from the input path provided
+
+    Args:
+        dir_path (optional): The path to the directory with the files to
+            be deprecated
+    """
+    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
+    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:
+            to_deprecate.append(
+                DeprecatedFile(
+                    file.name,
+                    file.absolute(),
+                    fh.read(),
+                )
+            )
+    return to_deprecate
+
+
+def _get_summary(content: str) -> Optional[str]:
+    """Extract the summary from the nasl script"""
+    pattern = get_script_tag_pattern(ScriptTag.SUMMARY)
+    if match_summary := re.search(pattern, content):
+        value = match_summary.group().split('value:"')[1]
+        return value.replace('");', "")
+    return None
+
+
+def deprecate(
+    output_path: Path,
+    to_deprecate: list[DeprecatedFile],
+    deprecation_reason: str,
+) -> None:
+    """Deprecate the selected VTs by removing unnecessary keys, updating the
+    summary, and adding the deprecated tag.
+
+    Args:
+        output_path: the directory where the deprecated VTs should be written
+            to, i.e. "attic"
+        to_deprecate: the list of files to be deprecated
+        deprecation_reason: The reason this VT is being deprecated,
+        from a list of options.
+    """
+    output_path.mkdir(parents=True, exist_ok=True)
+    for file in to_deprecate:
+        if re.findall(KB_ITEMS_PATTERN, file.content):
+            print(
+                f"Unable to deprecate {file.name}. There are still KB keys "
+                f"remaining."
+            )
+            continue
+        file.content = update_summary(file, deprecation_reason)
+        file.content = _finalize_content(file.content)
+
+        # Drop any unnecessary script tags like script_dependencies(),
+        # script_require_udp_ports() or script_mandatory_keys()
+        tags_to_remove = list()
+
+        if dependencies := re.search(
+            get_special_script_tag_pattern(SpecialScriptTag.DEPENDENCIES),
+            file.content,
+        ):
+            tags_to_remove.append(dependencies.group())
+
+        if udp := re.search(
+            get_special_script_tag_pattern(SpecialScriptTag.REQUIRE_UDP_PORTS),
+            file.content,
+        ):
+            tags_to_remove.append(udp.group())
+
+        if man_keys := re.search(
+            get_special_script_tag_pattern(SpecialScriptTag.MANDATORY_KEYS),
+            file.content,
+        ):
+            tags_to_remove.append(man_keys.group())
+
+        for tag in tags_to_remove:
+            file.content = file.content.replace("  " + tag + "\n", "")
+
+        file.full_path.rename(output_path / file.name)
+
+        with open(output_path / file.name, "w", encoding="latin-1") as f:
+            f.write(file.content)
+            f.truncate()
+
+
+def parse_args(args: Iterable[str] = None) -> Namespace:
+    parser = ArgumentParser(description="Deprecate VTs")
+    parser.add_argument(
+        "-o",
+        "--output-path",
+        metavar="<output_path>",
+        type=directory_type,
+        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",
+        metavar="<deprecation_reason>",
+        choices=[reason.name for reason in Deprecations],
+        type=str,
+        help="The reason the VT is being deprecated. Options are 'notus':"
+        "The VT has been replaced by a new Notus VT. 'Merged': the VT has"
+        "been merged with another still active VT, 'duplicate': The VT has"
+        "a still active duplicate, 'defunct': The VT is no longer "
+        "functional.",
+    )
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument(
+        "-f",
+        "--files",
+        metavar="<files>",
+        nargs="+",
+        default=None,
+        type=file_type,
+        help="Files to deprecate",
+    )
+    group.add_argument(
+        "-i",
+        "--input-path",
+        metavar="<input_path>",
+        default=None,
+        type=directory_type,
+        help="Path to the existing nasl script directory",
+    )
+    return parser.parse_args(args)
+
+
+def main():
+    args = parse_args()
+    input_path = args.input_path if args.input_path else None
+    filename_prefix = args.filename_prefix
+
+    files = args.files or get_files_from_path(input_path)
+    filtered_files = filter_files(files, filename_prefix)
+
+    deprecate(args.output_path, filtered_files, args.deprecation_reason)
+
+
+if __name__ == "__main__":
+    main()

{troubadix-24.7.1.dist-info → troubadix-24.7.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: troubadix
-Version: 24.7.1
+Version: 24.7.3
 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.7.1.dist-info → troubadix-24.7.3.dist-info}/RECORD

@@ -1,5 +1,5 @@
 troubadix/__init__.py,sha256=K7sIXXDrC7YRb7BvIpdQ6ZfG_QkT0qUH_wAlHROVRfM,716
-troubadix/__version__.py,sha256=mL2tC0y5b_pjx_tasGY6xoDz7aN4XEWC-5G3mdeIoTA,103
+troubadix/__version__.py,sha256=W7cqBfyqbLP9pEZlIH-kS8GRqdzbsgDZY7oYAswusxY,103
 troubadix/argparser.py,sha256=r9IkiYkd_8BqFGUEkhpawnW5DHo4hIciHd0dptToBjk,6999
 troubadix/codespell/codespell.additions,sha256=9hUrzjJF4Q8T5rVLx8CQa01oICvmsjzE6sCPjVRDOEU,418
 troubadix/codespell/codespell.exclude,sha256=qALEzLglEbPwcTRwGcobM_MTJzZyJekYRdJY3ws5yeM,138030
@@ -86,13 +86,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=gbvG8znQliwZ5XdHqnu-hSk36L33SDqZZhKQcvyGOSI,7661
 troubadix/standalone_plugins/file_extensions.py,sha256=3lEf73573RaTWgWZgiw8FFICKwc9FfFe8IKrufGofNM,2327
 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.7.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-troubadix-24.7.1.dist-info/METADATA,sha256=ZteAYoz8rPORdONVkWbsFOGJBcFIWU32C9doR1NQfyY,3965
-troubadix-24.7.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-troubadix-24.7.1.dist-info/entry_points.txt,sha256=oKf82stzVeO3JT7sayXgJm0MUS1aSP5VbSUfZ8HGVCU,665
-troubadix-24.7.1.dist-info/RECORD,,
+troubadix-24.7.3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+troubadix-24.7.3.dist-info/METADATA,sha256=k16fMjdhgIqxgS1CU5QonSY0VwFqqZ6xmK0_DTxCZks,3965
+troubadix-24.7.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+troubadix-24.7.3.dist-info/entry_points.txt,sha256=LplOk4nzKrS4B8Jz0SPkQLPlIDesdraCO8Vp_eoycpc,737
+troubadix-24.7.3.dist-info/RECORD,,

{troubadix-24.7.1.dist-info → troubadix-24.7.3.dist-info}/entry_points.txt

@@ -4,6 +4,7 @@ troubadix-allowed-rev-diff=troubadix.standalone_plugins.allowed_rev_diff:main
 troubadix-changed-cves=troubadix.standalone_plugins.changed_cves:main
 troubadix-changed-oid=troubadix.standalone_plugins.changed_oid:main
 troubadix-changed-packages=troubadix.standalone_plugins.changed_packages.changed_packages:main
+troubadix-deprecate-vts=troubadix.standalone_plugins.deprecate_vts:main
 troubadix-file-extensions=troubadix.standalone_plugins.file_extensions:main
 troubadix-last-modification=troubadix.standalone_plugins.last_modification:main
 troubadix-no-solution=troubadix.standalone_plugins.no_solution:main