Repository navigation
Executive Report
This feature is only available for our commercial versions.
The Executive Reports lets you create (as the name implies) reports using the results obtained in each workspace. When an Executive Report is created, all the data from the Status Report is automatically processed and placed in a Word compatible document that can then be downloaded.
To utilize this feature follow the necessary steps on our start up configuration.
To manage your reports you need to access Faraday's Web Interface and click on the icon executive reports ![] (https://raw.github.com/wiki/infobyte/faraday/images/faraday_report_icon.png)
All the reports will be listed, including their info and status.
Once a report has been generated it can't be edited.
To create a new report, navigate to the Executive Report component and click on New
- Title
- Scope
- Objectives
- Summary
- Conclusions
- Recommendations
Faraday processes all the information and spits out a shiny new report that is available for download from the same list.
If you need a custom report that includes only some of the findings in the workspace, you can tag the desired vulnerabilities and then create a Report only with that tag.
At least one vulnerability must be tagged in order to have the option to generate a filtered Report. When the form opens an option to select tags will appear. Keep in mind that one or more tags can be selected.
From the Executive Report window, select the document and click on Delete
All Report templates are located in reports/executive/templates. The default one is generic.docx, you can modify it to get customized reports.
The template uses Jinja2 syntax so we strongly recommend reading the official documentation before modifying the document. The library used to create the report is python-docx-template available via Github. All Jinja2 tags are available, although there are some restrictions.
An example of how the template cover looks like
Keep in mind that the data available to the Report is:
- conclusions - contains the text loaded when creating the report
- date - the date when the Report was created, as the name of the month and four digits for the year
- enterprise - contains the text loaded when creating the report
- hosts - a dictionary with all the hosts in the Workspace
- objectives - contains the text loaded when creating the report
- overview_images - a sub-document containing vulnerability piecharts
- recommendations - contains the text loaded when creating the report
- scope - contains the text loaded when creating the report
- services - a dictionary with all the services in the Workspace
- summary - contains the text loaded when creating the report
- title - contains the text loaded when creating the report
- vulns - a dictionary with all vulnerabilities in the Workspace
- vulns_amount - number of vulnerabilities in the Workspace