Using Markdown on a Report
For using markdown on Executive Reports, please enable it on /home/faraday/.faraday/config/server.ini by adding:
On your templates, to render the markdown you must use the p filter, like this:
Executive report supports markdown on the following fields:
Executive report scope
Executive report objectives
Executive report summary
Executive report conclusions
Executive report recommendations
And the following styles:
# H1 / ## H2 / ### H3
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Fenced Code Block
~~The world is flat.~~
You can use inline images with Faraday Evidence in the fields above by adding an Evidence file to your vulns and adding markdown like this:
For example, if you wanted to explain how to reproduce the issue in the Vulnerability description:
Make sure to always leave a space between your text and your image, otherwise the text above it won't be rendered.
Intro No more 3AM reporting! The Executive Report feature 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 ...
Import CSV using faraday_csv Plugin
With faraday_csv Plugin, you can upload data to Faraday by using CSV files. Main header: The main headers for faraday_csv Plugin are target or ip. Both columns contain the same information (host's IP). Without any of them, Faraday won't recognize ...
Executive Report jinja2 Template Context json
These are examples of jinja2 static dataset usage. You can access this information from the docx template. Executive reports use jinja for rendering the report, check jinja documentation for more details. methodologies can be used from version 3.12 ...
Build your own Report template
Available Variables The data available to the Report template is: General Variables 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 ...
Faraday is not importing my report
First let's make sure there is a Plugin to parse it so make sure your tool is listed in our Plugin List. Not there? Code your own or ask us to do it. You can also try to force Faraday to process a report with a certain plugin. For example, let's say ...