Parser Documentation Template | DefectDojo Documentation

Parser Documentation Template (Open Source)

This template is designed to document a new or existing parser. Please feel free to improve with any additional information that might help your fellow security professionals.

File Types

Specify all file types accepted by your parser (e.g., CSV, JSON, XML). Include instructions on how to create or export the acceptable file format from the related security tool.

Total Fields in [File Format]

Total data fields: Total number of fields contained in the security tool’s export file.
Total data fields parsed: Total number of fields parsed into DefectDojo finding.
Total data fields NOT parsed: Total number of fields NOT parsed into DefectDojo finding.

Using the format below, provide a brief description of each field and how it maps to DefectDojo’s data model. Include all fields found in the security tool’s export tile, in order of appearance, and noting any fields that are not parsed.

Fields in order of appearance:

  1. Field 1 - Description of how this field is mapped (e.g., maps to finding title, endpoint host.)
  2. Field 2 - Description of how this field is mapped / not mapped.
  3. Field 3 - Description of how this field is mapped / not mapped.
  4. Field 4 - Description of how this field is mapped / not mapped. (continue for every field in the file.)

Field Mapping Details

For each finding created, include details of how the parser parses specific data. For example:

Sample Scan Data or Unit Tests

Add a link to the unit tests or sample scan data folder in the GitHub repository. For example:

Link To Tool

Provide a link to the scanner or tool itself (e.g., GitHub repository, vendor website, or documentation). For example: