Print friendly Version of HTML report (#895)

Author: SinghHrmn

cve_bin_tool/async_utils.py

@@ -88,9 +88,9 @@ def __init__(self, *args, **kwargs):
         self._file = None
 
     async def __call__(self):
-        """ Convenience method to allow call like following:
-            f = await FileIO("some file path", "r")()
-            Note: We can't make async __init__
+        """Convenience method to allow call like following:
+        f = await FileIO("some file path", "r")()
+        Note: We can't make async __init__
         """
         return await self.open()
 

cve_bin_tool/checkers/sqlite.py

@@ -68,8 +68,7 @@ class SqliteChecker(Checker):
         VERSION_MAP = mapdb.get_mapping_data()
 
     def guess_contains(self, lines):
-        """Tries to determine if a file includes sqlite
-        """
+        """Tries to determine if a file includes sqlite"""
         # since the version strings are super unique here, we can guess the version
         # at the same time
 

cve_bin_tool/checkers/xml2.py

@@ -24,8 +24,7 @@ class Xml2Checker(Checker):
 
     @staticmethod
     def guess_xml2_version(lines):
-        """Guesses the xml2 version from the file contents
-        """
+        """Guesses the xml2 version from the file contents"""
         new_guess = ""
         pattern1 = re.compile(r"/libxml2-([0-9]+\.[0-9]+\.[0-9]+)/")
         pattern2 = re.compile(r"\\libxml2-([0-9]+\.[0-9]+\.[0-9]+)\\")

cve_bin_tool/cli.py

@@ -335,6 +335,7 @@ def main(argv=None):
             # Creates a Object for OutputEngine
             output = OutputEngine(
                 all_cve_data=cve_scanner.all_cve_data,
+                scanned_dir=args["directory"],
                 filename=args["output_file"],
                 themes_dir=args["html_theme"],
                 products_with_cve=cve_scanner.products_with_cve,

cve_bin_tool/cve_scanner.py

@@ -214,8 +214,8 @@ def get_cves(self, product_info: ProductInfo, triage_data: TriageData):
             self.all_cve_data[product_info]["cves"] = [CVE("UNKNOWN", "UNKNOWN")]
 
     def openssl_convert(self, version: str) -> str:
-        """ pkg_resources follows pep-440 which doesn't expect openssl style 1.1.0g version numbering
-        So to fake it, if the last character is a letter, replace it with .number before comparing """
+        """pkg_resources follows pep-440 which doesn't expect openssl style 1.1.0g version numbering
+        So to fake it, if the last character is a letter, replace it with .number before comparing"""
         if not version:  # if version is empty return it.
             return version
 
@@ -226,7 +226,7 @@ def openssl_convert(self, version: str) -> str:
         return version
 
     def affected(self):
-        """ Returns list of product name and version tuples identified from
+        """Returns list of product name and version tuples identified from
         scan"""
         return sorted(
             [(cve_data.product, cve_data.version) for cve_data in self.all_cve_data]

cve_bin_tool/cvedb.py

@@ -237,7 +237,7 @@ def refresh_cache_and_update_db(self):
         self.populate_db()
 
     def get_cvelist_if_stale(self):
-        """ Update if the local db is more than one day old.
+        """Update if the local db is more than one day old.
         This avoids the full slow update with every execution.
         """
         if not os.path.isfile(self.dbpath) or (
@@ -303,7 +303,7 @@ def init_database(self):
         self.connection.commit()
 
     def populate_db(self):
-        """ Function that populates the database from the JSON.
+        """Function that populates the database from the JSON.
 
         WARNING: After some inspection of the data, we are assuming that start/end ranges are kept together
         in single nodes.  This isn't *required* by the json so may not be true everywhere.  If that's the case,

cve_bin_tool/error_handler.py

@@ -84,7 +84,7 @@ def excepthook(exc_type, exc_val, exc_tb):
 
 
 class ErrorHandler:
-    """ Error handler context manager.
+    """Error handler context manager.
 
     Supports Different modes like ignore error, print full trace, truncated trace and no trace.
     Log messages if logger specified.

cve_bin_tool/file.py

@@ -9,7 +9,7 @@
 
 
 async def aio_is_binary(filename):
-    """ Read the magic bytes from a file and determine if it is an executable
+    """Read the magic bytes from a file and determine if it is an executable
     binary."""
     signature = await read_signature(filename)
     for name, method in inspect.getmembers(

cve_bin_tool/output_engine/__init__.py

@@ -43,6 +43,7 @@ class OutputEngine:
     def __init__(
         self,
         all_cve_data: Dict[ProductInfo, CVEData],
+        scanned_dir: str,
         filename: str,
         themes_dir: str,
         logger: Logger = None,
@@ -52,14 +53,15 @@ def __init__(
     ):
         self.logger = logger or LOGGER.getChild(self.__class__.__name__)
         self.all_cve_data = all_cve_data
+        self.scanned_dir = scanned_dir
         self.filename = os.path.abspath(filename) if filename else ""
         self.products_with_cve = products_with_cve
         self.products_without_cve = products_without_cve
         self.total_files = total_files
         self.themes_dir = themes_dir
 
     def output_cves(self, outfile, output_type="console"):
-        """ Output a list of CVEs
+        """Output a list of CVEs
         format self.checkers[checker_name][version] = dict{id: severity}
         to other formats like CSV or JSON
         """
@@ -70,6 +72,7 @@ def output_cves(self, outfile, output_type="console"):
         elif output_type == "html":
             output_html(
                 self.all_cve_data,
+                self.scanned_dir,
                 self.filename,
                 self.themes_dir,
                 self.total_files,

cve_bin_tool/output_engine/html.py

@@ -46,6 +46,7 @@ def render_cves(
 
 def output_html(
     all_cve_data: Dict[ProductInfo, CVEData],
+    scanned_dir: str,
     filename: str,
     theme_dir: str,
     total_files: int,
@@ -54,8 +55,7 @@ def output_html(
     logger: LOGGER,
     outfile,
 ):
-    """Returns a HTML report for CVE's
-    """
+    """Returns a HTML report for CVE's"""
 
     # Step 1: Load all the templates
 
@@ -240,9 +240,11 @@ def output_html(
         base.render(
             date=datetime.now().strftime("%d %b %Y"),
             dashboard=dashboard,
+            scanned_dir=scanned_dir,
             all_paths=all_paths,
             print_mode=html_print_mode(
                 all_cve_data,
+                scanned_dir,
                 products_with_cve,
                 products_without_cve,
                 total_files,