helperFunctions.pdf module

helperFunctions.pdf.build_pdf_report(firmware, folder)

Creates a pdf report for the given firmware by calling the fact_pdf_report docker container.

About the pdf report

The pdf report tool is based on the jinja2 templating engine and renders a latex file that is build into a one page overview of the analysis results. For all technical details refer to the implementation.

Parameters:

• firmware (Firmware) – The firmware to generate the pdf report for

• folder (Path) – An empty folder in which to generate the resulting pdf in

Returns:

The path to the generated pdf file inside the given folder

Return type:

Path