feat(checker): allow to disable language checker (#5049)

Allow the user to enable or disable language checkers

While at it, also fix a typo dictoinary -> dictionary

Signed-off-by: Fabrice Fontaine <[email protected]>

Author: ffontaine

cve_bin_tool/cli.py

@@ -992,7 +992,6 @@ def main(argv=None):
             raise FileNotFoundError("Directory/File doesn't exist")
 
     # Checkers related settings
-    skips = args["skips"]
     if args["runs"]:
         runs = args["runs"]
         skips = list(
@@ -1004,6 +1003,34 @@ def main(argv=None):
                 ),
             )
         )
+        language_skips = list(
+            map(
+                lambda checker_name: checker_name,
+                filter(
+                    lambda checker_name: checker_name not in runs,
+                    VersionScanner.available_language_checkers(),
+                ),
+            )
+        )
+    else:
+        skips = list(
+            map(
+                lambda checker_name: checker_name,
+                filter(
+                    lambda checker_name: checker_name in args["skips"],
+                    VersionScanner.available_checkers(),
+                ),
+            )
+        )
+        language_skips = list(
+            map(
+                lambda checker_name: checker_name,
+                filter(
+                    lambda checker_name: checker_name in args["skips"],
+                    VersionScanner.available_language_checkers(),
+                ),
+            )
+        )
 
     if (
         not args["input_file"]
@@ -1098,6 +1125,7 @@ def main(argv=None):
             version_scanner.remove_skiplist(skips)
             LOGGER.info(f"Number of checkers: {version_scanner.number_of_checkers()}")
             version_scanner.print_checkers()
+            version_scanner.remove_language_skiplist(language_skips)
             LOGGER.debug(
                 "If the checkers aren’t loading properly: https://cve-bin-tool.readthedocs.io/en/latest/CONTRIBUTING.html#help-my-checkers-aren-t-loading"
             )

cve_bin_tool/version_scanner.py

@@ -69,7 +69,8 @@ def __init__(
         self.cve_db = CVEDB(sources=sources)
         self.validate = validate
         # self.logger.info("Checkers loaded: %s" % (", ".join(self.checkers.keys())))
-        self.language_checkers = self.available_language_checkers()
+        self.language_checkers = valid_files
+        self.language_checkers_names = self.available_language_checkers()
 
     @classmethod
     def load_checkers(cls) -> dict[str, type[Checker]]:
@@ -115,7 +116,7 @@ def remove_skiplist(self, skips: list[str]) -> None:
                 self.logger.error(f"Checker {skipme} is not a valid checker name")
 
     def print_checkers(self) -> None:
-        """Print checkers and logs an informational message that lists the names of the checkers stored in the dictoionary"""
+        """Print checkers and logs an informational message that lists the names of the checkers stored in the dictionary"""
 
         self.logger.info(f'Checkers: {", ".join(self.checkers.keys())}')
 
@@ -131,13 +132,36 @@ def available_language_checkers(cls) -> list[str]:
         """Find Language checkers"""
         return sorted(available_parsers)
 
+    def remove_language_skiplist(self, language_skips: list[str]) -> None:
+        """Remove specific language checkers If a checker is in the skip list, it will be removed from this dictionary. If it's not found or is not a valid language checker name, it logs error messages."""
+
+        # Take out any language checkers that are on the skip list
+        # (string of comma-delimited language checker names)
+        skiplist = language_skips
+        for skipme in skiplist:
+            if skipme not in self.language_checkers_names:
+                self.logger.error(
+                    f"Checker {skipme} is not a valid language checker name"
+                )
+            else:
+                self.logger.debug(f"Skipping language checker: {skipme}")
+                self.language_checkers_names.remove(skipme)
+                for checker in list(self.language_checkers.keys()):
+                    if (
+                        skipme
+                        in self.language_checkers[checker][0].__module__.split(".")[2]
+                    ):
+                        del self.language_checkers[checker]
+
     def print_language_checkers(self) -> None:
         """Logs the message that lists the names of the language checkers"""
-        self.logger.info(f'Language Checkers: {", ".join(self.language_checkers)}')
+        self.logger.info(
+            f'Language Checkers: {", ".join(self.language_checkers_names)}'
+        )
 
     def number_of_language_checkers(self) -> int:
         """return the number of language checkers available"""
-        return len(self.language_checkers)
+        return len(self.language_checkers_names)
 
     def is_executable(self, filename: str) -> tuple[bool, str | None]:
         """check if file is an ELF binary file"""
@@ -238,7 +262,7 @@ def scan_file(self, filename: str) -> Iterator[ScanInfo]:
 
         if output:
             valid_file = False
-            for file in list(valid_files.keys()):
+            for file in list(self.language_checkers.keys()):
                 valid_file = valid_file | (file in output)
             if valid_file:
                 for scan_info in parse(filename, output, self.cve_db, self.logger):