Skip to content

Report Creation

Jump to bottom
AlgoSecureAdmin edited this page Jul 6, 2020 · 1 revision

Requirements

  • DOCX templates must include:
    • A style named BulletList to convert Markdown lists.
    • A style named Normal to use for paragraphs
    • A style named Normal_Cell to use for text in tables (without first Alinea).
  • PPTX templates must include:
    • a Slide Layout named TO_COPY. This Layout must be blank or eventually with a Title placeholder

Variables

Both docx and pptx templates have a set of variables to be replaced. Here is the list:

Global variables

Variable Value Replaced in Paragraphs Replaced in Tables Comments
var_contract Report contract field YES YES
var_synthesis ToDo main redactor YES   YES
var_nb_d_total Total number of security defects found YES YES
var_nb_d_critical Number of critical security defects found YES YES
var_nb_d_major Number of major security defects found YES YES
var_nb_d_important Number of important security defects found YES YES
var_nb_d_minor Number of minor security defects found YES YES
var_nb_fix Number of fix found YES YES Only Powerpoint

Summary tables (DOCX ONLY)

Three tables are available : defects, fixes and a combination of the both. Variables starting with var_dsum must be present in the same table placeholder. You can only change column order. Variables starting with var_csum must be present in the same table placeholder. You can only change column order. The var_res_table must be in a table with 6 columns and be in the first column.

Variable Value Replaced in Paragraphs Replaced in Tables Comments
var_dsum_colId ID NO YES Use to show the parser the defect summary table and ID column
var_dsum_colTit Libellé NO YES Use to show the parser the defect summary title column
var_dsum_colEase Exploitation NO YES Use to show the parser the defect summary ease column
var_dsum_colImpact Impact NO YES Use to show the parser the defect summary impact column
var_dsum_colType Type NO YES Use to show the parser the defect summary type column
var_csum_colId ID NO YES Use to show the parser the fixes summary table and ID column
var_csum_colTit Libellé NO YES Use to show the parser the fixes summary title column
var_csum_colEase Mise en\nœuvre NO YES Use to show the parser the fixes ease column
var_csum_colGain Gain en sécurité NO YES Use to show the parser the fixes gain column
var_res_tab ID NO YES Use to show the parser the defect and fix summary table. Auto constructed

Defects and fix individual tables

For this section to work properly you must have on your template somewhere 5 tables with var_d_separator between each of them. The 5 tables are used like this:

  1. Critical security defects
  2. Major security defects
  3. Important security defects
  4. Minor security defects
  5. Fixes

Each of the 4 defect table must have those variables so only the font/colors/format can be changed:

Variable Value Replaced in Paragraphs Replaced in Tables Comments
var_d_id DY where X is the Defect number NO YES Used to show the parser one of the defect description table
var_d_title defect title in the table found with var_d_id NO YES
var_d_ease defect ease in the table found with var_d_id NO YES
var_d_impact defect impact in the table found with var_d_id NO YES
var_d_description defect description in the table found with var_d_id NO YES

DO NOT forget the var_d_separator after every security defect table. The var_d_separator will be replace with the ToDo mention followed by each object affected by this security defect notes and proofs. Then the fix table will be duplicated for each fix registered for this defect.

The Fixe template table must include those variables

Variable Value Replaced in Paragraphs Replaced in Tables Comments
var_c_id AX.Y where X is the Defect number and Y this defect's fix count NO YES Used to show the parser the fix description table to be copied after defect table
var_c_title Fix title in the table found with var_c_id NO YES
var_c_ease Fix ease in the table found with var_c_id NO YES DOCX ONLY
var_c_gain Fix gain in the table found with var_c_id NO YES DOCX ONLY
var_c_description Fix description in the table found with var_c_id NO YES DOCX ONLY

After each fix table, fix notes may be added.

Service table

The service table shows for each IP what port are open and notes about those ports. The service table must have those 4 variables in a separated column:

Variable Value Replaced in Paragraphs Replaced in Tables Comments
var_ssum_ip IP NO YES Used to show the parser the service table
var_ssum_port Port NO YES
var_ssum_proto Protocole NO YES
var_ssum_comment Commentaires NO YES

Defects chart (PPTX ONLY)

The first chart on your PPTX template will have its data replaced with the defects count for every risk level.

Home

Clone this wiki locally