Skip to content

Commit

Permalink
Update Parser Documentation Template to include more detailed informa…
Browse files Browse the repository at this point in the history
…tion
  • Loading branch information
skywalke34 committed Feb 27, 2025
1 parent 5f229c6 commit cda65f6
Showing 1 changed file with 29 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,37 @@ weight: 1

Use this template as part of writing a new parser.

* Copy this .md file and add it to docs/integrations/parsers/file in the GitHub repository
* Update the title to match the name of your new parser
* Fill out all sections listed below
* Copy this .md file and add it to `/docs/content/en/connecting_your_tools/parsers/file` in the GitHub repository.
* Update the title to match the name of your new parser.
* Fill out all sections listed below.

### File Types
Specify all file types accepted by your parser. Include a process for creating the acceptable file from the related security tool.
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.

### Sample Scan Data / Unit Tests
Add a link to the relevant unit tests or sample scan data folder in the GitHub repository.
### Total Fields in [File Format]
List the total number of fields in the file format (e.g., CSV, JSON, XML).
Provide a brief description of each field and how it maps to DefectDojo's data model.
Include all fields, 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, etc.).
2. **Field 2** - Description of how this field is mapped or not mapped.
3. **Field 3** - Description of how this field is mapped or not mapped.
4. **Field 4** - Description of how this field is mapped or 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:
- Explains how endpoints are created (e.g., combining IP, Domain, Port, and Protocol fields).
- Describes how occurrences are handled (e.g., default `nb_occurences` set to 1, incremented for duplicates).
- Explains how deduplication is handled (e.g., using a hash of severity + title + description).
- Describes the default severity if no mapping is matched.

### Sample Scan Data
Add a link to the relevant unit tests or sample scan data folder in the GitHub repository. For example:
- [Sample Scan Data Folder](https://github.com/DefectDojo/django-DefectDojo/tree/master/unittests/scans/[parser-name])

### Link To Tool
A link to the scanner itself - (e.g. GitHub or appropriate vendor link)
Provide a link to the scanner or tool itself (e.g., GitHub repository, vendor website, or documentation). For example:
- [Tool Name](https://www.example.com/)

0 comments on commit cda65f6

Please sign in to comment.