troubadix 25.12.4__py3-none-any.whl → 26.2.0__py3-none-any.whl

troubadix/plugins/script_version_and_last_modification_tags.py

@@ -84,9 +84,7 @@ class CheckScriptVersionAndLastModificationTags(FileContentPlugin):
         self.old_script_version_value = match_script_version_any.group("value")
 
         # script_version("2019-03-21T12:19:01+0000");")
-        version_pattern = get_special_script_tag_pattern(
-            SpecialScriptTag.VERSION
-        )
+        version_pattern = get_special_script_tag_pattern(SpecialScriptTag.VERSION)
         version_match = version_pattern.search(file_content)
 
         if not version_match:
@@ -122,22 +120,17 @@ class CheckScriptVersionAndLastModificationTags(FileContentPlugin):
             return
 
         self.old_last_modification = match_last_modification_any_value.group(0)
-        self.old_last_modification_value = (
-            match_last_modification_any_value.group("value")
-        )
+        self.old_last_modification_value = match_last_modification_any_value.group("value")
 
         # script_tag(name:"last_modification",
         # value:"2019-03-21 12:19:01 +0000 (Thu, 21 Mar 2019)");
-        last_modification_pattern = get_script_tag_pattern(
-            ScriptTag.LAST_MODIFICATION
-        )
+        last_modification_pattern = get_script_tag_pattern(ScriptTag.LAST_MODIFICATION)
         match_last_modified = last_modification_pattern.search(file_content)
 
         if not match_last_modified:
             self.fix_last_modification_and_version = True
             yield LinterError(
-                "VT is is using a wrong syntax for script_tag("
-                'name:"last_modification".',
+                'VT is is using a wrong syntax for script_tag(name:"last_modification".',
                 file=nasl_file,
                 plugin=self.name,
             )
@@ -198,18 +191,14 @@ class CheckScriptVersionAndLastModificationTags(FileContentPlugin):
 
         # get that last modification date formatted correctly:
         # "2021-03-24 10:08:26 +0000 (Wed, 24 Mar 2021)"
-        correctly_formatted_last_modification = (
-            f"{now:%Y-%m-%d %H:%M:%S %z (%a, %d %b %Y)}"
-        )
+        correctly_formatted_last_modification = f"{now:%Y-%m-%d %H:%M:%S %z (%a, %d %b %Y)}"
 
         file_content = file_content.replace(
             self.old_last_modification,
             tag_template.format(date=correctly_formatted_last_modification),
         )
 
-        self.context.nasl_file.write_text(
-            file_content, encoding=CURRENT_ENCODING
-        )
+        self.context.nasl_file.write_text(file_content, encoding=CURRENT_ENCODING)
 
         yield LinterFix(
             f"Replaced last_modification {self.old_last_modification_value} "

troubadix/plugins/script_xref_form.py

@@ -41,9 +41,7 @@ class CheckScriptXrefForm(FileContentPlugin):
         if matches:
             for match in matches:
                 if match:
-                    if not get_xref_pattern(name=r".*", value=r".*").match(
-                        match.group(0)
-                    ):
+                    if not get_xref_pattern(name=r".*", value=r".*").match(match.group(0)):
                         yield LinterError(
                             f"{match.group(0)}: does not conform to"
                             ' script_xref(name:"<name>", value:<value>);',

troubadix/plugins/script_xref_url.py

@@ -30,10 +30,8 @@ ALLOWED_URLS = [
     + "fbd2dac042934e49288b476d5f6a649e5da2@<announce.tomcat.apache.org>",
     "https://m0ze.ru/vulnerability/[2021-05-26]-[WordPress]-[C"
     + "WE-79]-WP-Reset-WordPress-Plugin-v1.86.txt",
-    "http://yehg.net/lab/pr0js/advisories/joomla/core/[joomla_"
-    + "1.0.x~15]_cross_site_scripting",
-    "http://yehg.net/lab/pr0js/advisories/eclipse/[eclipse_hel"
-    + "p_server]_cross_site_scripting",
+    "http://yehg.net/lab/pr0js/advisories/joomla/core/[joomla_" + "1.0.x~15]_cross_site_scripting",
+    "http://yehg.net/lab/pr0js/advisories/eclipse/[eclipse_hel" + "p_server]_cross_site_scripting",
     "http://core.yehg.net/lab/pr0js/advisories/dll_hijacking/["
     + "flash_player]_10.1.x_insecure_dll_hijacking_(dwmapi.dll)",
     "https://lists.apache.org/thread.html/773c93c2d8a6a52bbe9"
@@ -62,9 +60,7 @@ class CheckScriptXrefUrl(FileContentPlugin):
         if nasl_file.suffix == ".inc":
             return
 
-        matches = get_xref_pattern(name="URL", value=r".+?").finditer(
-            file_content
-        )
+        matches = get_xref_pattern(name="URL", value=r".+?").finditer(file_content)
         for match in matches:
             if match:
                 url_value = match.group("value")

troubadix/plugins/security_messages.py

@@ -36,8 +36,7 @@ def _file_contains_security_message(file_content: str) -> bool:
         file_content (str): The content of the VT
     """
     return any(
-        security_message in file_content
-        for security_message in SECURITY_MESSAGE_IMPLEMENTATIONS
+        security_message in file_content for security_message in SECURITY_MESSAGE_IMPLEMENTATIONS
     )
 
 
@@ -54,16 +53,13 @@ class CheckSecurityMessages(FileContentPlugin):
             nasl_file (Path): The VTs path
             file_content (str): The content of the VT
         """
-        deprecated_pattern = get_script_tag_pattern(
-            script_tag=ScriptTag.DEPRECATED
-        )
+        deprecated_pattern = get_script_tag_pattern(script_tag=ScriptTag.DEPRECATED)
         if deprecated_pattern.search(file_content):
             return
 
         if not _file_contains_security_message(file_content):
             yield LinterError(
-                "VT is missing a security_message or implementing"
-                " function in a VT with severity",
+                "VT is missing a security_message or implementing function in a VT with severity",
                 file=nasl_file,
                 plugin=self.name,
             )
@@ -84,15 +80,12 @@ class CheckSecurityMessages(FileContentPlugin):
 
         if _file_contains_security_message(file_content):
             yield LinterError(
-                "VT is using a security_message or implementing"
-                " function in a VT without severity",
+                "VT is using a security_message or implementing function in a VT without severity",
                 file=nasl_file,
                 plugin=self.name,
             )
 
-    def _determinate_security_message_by_severity(
-        self, file_content: str
-    ) -> bool:
+    def _determinate_security_message_by_severity(self, file_content: str) -> bool:
         """Determinates wether a VT requires a
         security_message or implementing function
         call
@@ -122,15 +115,9 @@ class CheckSecurityMessages(FileContentPlugin):
         if nasl_file.suffix == ".inc":
             return
 
-        security_message_required = (
-            self._determinate_security_message_by_severity(file_content)
-        )
+        security_message_required = self._determinate_security_message_by_severity(file_content)
 
         if security_message_required:
-            yield from self._check_security_message_present(
-                nasl_file, file_content
-            )
+            yield from self._check_security_message_present(nasl_file, file_content)
         else:
-            yield from self._check_security_message_absent(
-                nasl_file, file_content
-            )
+            yield from self._check_security_message_absent(nasl_file, file_content)

troubadix/plugins/severity_date.py

@@ -20,18 +20,13 @@ class CheckSeverityDate(FileContentPlugin):
         nasl_file: Path,
         file_content: str,
     ) -> Iterator[LinterResult]:
-
         if nasl_file.suffix == ".inc":
             return
 
         severity_date_pattern = get_script_tag_pattern(ScriptTag.SEVERITY_DATE)
-        last_modification_pattern = get_script_tag_pattern(
-            ScriptTag.LAST_MODIFICATION
-        )
+        last_modification_pattern = get_script_tag_pattern(ScriptTag.LAST_MODIFICATION)
 
-        if not (
-            match_severity_date := severity_date_pattern.search(file_content)
-        ):
+        if not (match_severity_date := severity_date_pattern.search(file_content)):
             return
 
         yield from check_date(
@@ -41,9 +36,7 @@ class CheckSeverityDate(FileContentPlugin):
             self.name,
         )
 
-        if match_last_mod_date := last_modification_pattern.search(
-            file_content
-        ):
+        if match_last_mod_date := last_modification_pattern.search(file_content):
             yield from compare_date_with_last_modification_date(
                 match_severity_date.group("value"),
                 "severity_date",

troubadix/plugins/severity_format.py

@@ -16,13 +16,10 @@ class CheckSeverityFormat(FileContentPlugin):
         nasl_file: Path,
         file_content: str,
     ) -> Iterator[LinterResult]:
-
         if nasl_file.suffix == ".inc" or "severity_vector" not in file_content:
             return
 
-        severity_vector_pattern = get_script_tag_pattern(
-            ScriptTag.SEVERITY_VECTOR
-        )
+        severity_vector_pattern = get_script_tag_pattern(ScriptTag.SEVERITY_VECTOR)
 
         severity_vector_match = severity_vector_pattern.search(file_content)
         if not severity_vector_match:

troubadix/plugins/severity_origin.py

@@ -16,13 +16,10 @@ class CheckSeverityOrigin(FileContentPlugin):
         nasl_file: Path,
         file_content: str,
     ) -> Iterator[LinterResult]:
-
         if nasl_file.suffix == ".inc" or "severity_origin" not in file_content:
             return
 
-        severity_origin_pattern = get_script_tag_pattern(
-            ScriptTag.SEVERITY_ORIGIN
-        )
+        severity_origin_pattern = get_script_tag_pattern(ScriptTag.SEVERITY_ORIGIN)
 
         severity_origin_match = severity_origin_pattern.search(file_content)
         if not severity_origin_match:

troubadix/plugins/solution_text.py

@@ -98,11 +98,9 @@ class CheckSolutionText(FilePlugin):
         )
         file_content = self.context.file_content
 
-        if _get_tag_pattern(
-            name=ScriptTag.SOLUTION_TYPE.value, value="NoneAvailable"
-        ).search(file_content) and not re.search(
-            correct_none_available_pattern, file_content
-        ):
+        if _get_tag_pattern(name=ScriptTag.SOLUTION_TYPE.value, value="NoneAvailable").search(
+            file_content
+        ) and not re.search(correct_none_available_pattern, file_content):
             yield LinterError(
                 "The VT with solution type 'NoneAvailable' is using an "
                 "incorrect syntax in the solution text. Please use "
@@ -110,11 +108,9 @@ class CheckSolutionText(FilePlugin):
                 file=self.context.nasl_file,
                 plugin=self.name,
             )
-        elif _get_tag_pattern(
-            name=ScriptTag.SOLUTION_TYPE.value, value="WillNotFix"
-        ).search(file_content) and not re.search(
-            correct_will_not_fix_pattern, file_content
-        ):
+        elif _get_tag_pattern(name=ScriptTag.SOLUTION_TYPE.value, value="WillNotFix").search(
+            file_content
+        ) and not re.search(correct_will_not_fix_pattern, file_content):
             yield LinterError(
                 "The VT with solution type 'WillNotFix' is using an incorrect "
                 "syntax in the solution text. Please use one of these "

troubadix/plugins/solution_type.py

@@ -53,8 +53,7 @@ class CheckSolutionType(FileContentPlugin):
 
         has_severity = True
         cvss_detect = re.search(
-            r"script_tag\s*\(name\s*:\s*\"cvss_base\","
-            r"\s*value:\s*\"(\d{1,2}\.\d)\"\)",
+            r"script_tag\s*\(name\s*:\s*\"cvss_base\"," r"\s*value:\s*\"(\d{1,2}\.\d)\"\)",
             file_content,
         )
         if cvss_detect is not None and cvss_detect.group(1) == "0.0":

troubadix/plugins/spaces_before_dots.py

@@ -71,9 +71,7 @@ IGNORE = [
 class CheckSpacesBeforeDots(FileContentPlugin):
     name = "check_spaces_before_dots"
 
-    def check_content(
-        self, nasl_file: Path, file_content: str
-    ) -> Iterator[LinterResult]:
+    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
@@ -103,7 +101,6 @@ class CheckSpacesBeforeDots(FileContentPlugin):
                 )
 
     def fix(self) -> Iterator[LinterResult]:
-
         if not self.matches:
             return
 
@@ -114,11 +111,7 @@ class CheckSpacesBeforeDots(FileContentPlugin):
         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) :]
-            )
+            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)

troubadix/plugins/spaces_in_filename.py

@@ -13,8 +13,7 @@ class CheckSpacesInFilename(FilePlugin):
     def run(self) -> Iterator[LinterResult]:
         if re.search(r"\s", self.context.nasl_file.name):
             yield LinterError(
-                f"The VT {self.context.nasl_file}"
-                " contains whitespace in the filename",
+                f"The VT {self.context.nasl_file} contains whitespace in the filename",
                 file=self.context.nasl_file,
                 plugin=self.name,
             )

troubadix/plugins/spelling.py

@@ -48,9 +48,7 @@ exceptions = [
     # Same for a few other files:
     PatternInFileCheck("smtp_AV_42zip_DoS.nasl", r"BA\s+==>\s+BY, BE"),
     PatternInFileCheck("bad_ssh_host_keys.inc", r"ba\s+==>\s+by, be"),
-    PatternsInFileCheck(
-        "wmi_misc.inc", [r"BA\s+==>\s+BY, BE", r"OD\s+==>\s+OF"]
-    ),
+    PatternsInFileCheck("wmi_misc.inc", [r"BA\s+==>\s+BY, BE", r"OD\s+==>\s+OF"]),
     PatternInFilesCheck(
         ["ssl_funcs.inc", "gb_ssl_tls_cert_details.nasl"],
         r"fpr\s+==>\s+for, far, fps",
@@ -104,9 +102,7 @@ exceptions = [
         r"n[iI]n\s+==>\s+inn",
     ),
     # False positive in this VT in German example responses.
-    PatternInFileCheck(
-        "gb_exchange_server_CVE-2021-26855_active.nasl", r"ist\s+==>\s+is"
-    ),
+    PatternInFileCheck("gb_exchange_server_CVE-2021-26855_active.nasl", r"ist\s+==>\s+is"),
     # Mostly a false positive in LSCs because of things like
     # "ALSA: hda" or a codec called "Conexant". There are too
     # many hits to maintain them in codespell.exclude so exclude
@@ -152,9 +148,7 @@ exceptions = [
         r"nam\s+==>\s+name",
         text_pattern_flags=re.IGNORECASE,
     ),
-    PatternInFileCheck(
-        "/netop_infopublic.nasl", r"nam\s+==>\s+name", flags=re.IGNORECASE
-    ),
+    PatternInFileCheck("/netop_infopublic.nasl", r"nam\s+==>\s+name", flags=re.IGNORECASE),
     # Product names used in a few VTs (no re.IGNORECASE is expected)
     PatternsCheck([r"renderD\s+==>\s+rendered", r"VertX\s+==>\s+vertex"]),
     PatternInFileCheck("_vertx_", r"vertx\s+==>\s+vertex"),
@@ -206,8 +200,7 @@ class CheckSpelling(FilesPlugin):
         batch_size = 10_000
         for i in range(0, len(self.context.nasl_files), batch_size):
             files_parameters = [
-                str(nasl_file)
-                for nasl_file in self.context.nasl_files[i : i + batch_size]
+                str(nasl_file) for nasl_file in self.context.nasl_files[i : i + batch_size]
             ]
             codespell_arguments = [
                 "--hard-encoding-detection",
@@ -235,9 +228,7 @@ class CheckSpelling(FilesPlugin):
             codespell_entries = [
                 line
                 for line in codespell_output.splitlines()
-                if not handle_linguistic_checks(
-                    *self._parse_codespell_line(line), exceptions
-                )
+                if not handle_linguistic_checks(*self._parse_codespell_line(line), exceptions)
             ]
 
             for codespell_entry in codespell_entries:

troubadix/plugins/trailing_spaces_tabs.py

@@ -39,15 +39,12 @@ class CheckTrailingSpacesTabs(FilePlugin):
                     to find special tags
 
         """
-        for line_number, line in enumerate(
-            self.context.file_content.splitlines(), start=1
-        ):
+        for line_number, line in enumerate(self.context.file_content.splitlines(), start=1):
             if not PATTERN.search(line):
                 continue
 
             yield LinterError(
-                "The VT has one or more trailing spaces "
-                f"and/or tabs in line {line_number}!",
+                f"The VT has one or more trailing spaces and/or tabs in line {line_number}!",
                 file=self.context.nasl_file,
                 plugin=self.name,
             )

troubadix/plugins/using_display.py

@@ -63,9 +63,7 @@ class CheckUsingDisplay(FileContentPlugin):
 
             # Case 1: Not in any if statement - ERROR
             if not containing_if:
-                line_start = (
-                    comment_free_content.rfind("\n", 0, display_pos) + 1
-                )
+                line_start = comment_free_content.rfind("\n", 0, display_pos) + 1
                 line_end = comment_free_content.find("\n", display_pos)
                 if line_end == -1:
                     line_end = len(comment_free_content)
@@ -95,9 +93,7 @@ class CheckUsingDisplay(FileContentPlugin):
                 yield LinterWarning(
                     "VT is using a display() inside an if statement"
                     f" but without debug check at line {line}\n"
-                    + comment_free_content[
-                        containing_if.if_start : containing_if.if_end
-                    ],
+                    + comment_free_content[containing_if.if_start : containing_if.if_end],
                     file=nasl_file,
                     plugin=self.name,
                 )