|
1 | 1 | --- |
2 | | -title: "Generic Findings Import" |
| 2 | +title: "Using Generic Findings Import" |
3 | 3 | toc_hide: true |
4 | 4 | weight: 2 |
5 | 5 | --- |
6 | 6 |
|
7 | | -You can use Generic Findings Import as a method to ingest JSON or CSV files into DefectDojo which are not already in the supported parsers list. |
| 7 | +Open-source and Pro users can use Generic Findings Import as a method to ingest JSON or CSV files into DefectDojo which are not already in the supported Tools list. |
8 | 8 |
|
9 | | -Files uploaded using Generic Findings Import must conform to the accepted format with respect to CSV column headers / JSON attributes. |
| 9 | +Using Generic Findings Import will create a new Test Type in your DefectDojo instance called "`{The Name Of Your Test}` (Generic Findings Import)". For example, this JSON content will result in a Test Type called "Example Report (Generic Findings Import)": |
10 | 10 |
|
11 | | -These attributes are supported for CSV: |
12 | | - |
13 | | -- Date: Date of the finding in mm/dd/yyyy format. |
14 | | -- Title: Title of the finding |
15 | | -- CweId: Cwe identifier, must be an integer value. |
16 | | -- epss_score: The probability of exploitation in the next 30 days, must be a float value between 0 and 1.0. |
17 | | -- epss_percentile: The proportion of all scored vulnerabilities with the same or a lower EPSS score, must be a float value between 0 and 1.0. |
18 | | -- Url: Url associated with the finding. |
19 | | -- Severity: Severity of the finding. Must be one of Info, Low, Medium, High, or Critical. |
20 | | -- Description: Description of the finding. Can be multiple lines if enclosed in double quotes. |
21 | | -- Mitigation: Possible Mitigations for the finding. Can be multiple lines if enclosed in double quotes. |
22 | | -- Impact: Detailed impact of the finding. Can be multiple lines if enclosed in double quotes. |
23 | | -- References: References associated with the finding. Can be multiple lines if enclosed in double quotes. |
24 | | -- Active: Indicator if the finding is active. Must be empty, TRUE or FALSE |
25 | | -- Verified: Indicator if the finding has been verified. Must be empty, TRUE, or FALSE |
26 | | -- FalsePositive: Indicator if the finding is a false positive. Must be TRUE, or FALSE. |
27 | | -- Duplicate: Indicator if the finding is a duplicate. Must be TRUE, or FALSE |
28 | | - |
29 | | -The CSV expects a header row with the names of the attributes. |
30 | | - |
31 | | -Example of JSON format: |
32 | | - |
33 | | -```JSON |
34 | | -{ |
35 | | - "findings": [ |
36 | | - { |
37 | | - "title": "test title with endpoints as dict", |
38 | | - "description": "Some very long description with\n\n some UTF-8 chars à qu'il est beau", |
39 | | - "severity": "Medium", |
40 | | - "mitigation": "Some mitigation", |
41 | | - "date": "2021-01-06", |
42 | | - "cve": "CVE-2020-36234", |
43 | | - "cwe": 261, |
44 | | - "cvssv3": "CVSS:3.1/AV:N/AC:L/PR:H/UI:R/S:C/C:L/I:L/A:N", |
45 | | - "file_path": "src/first.cpp", |
46 | | - "line": 13, |
47 | | - "endpoints": [ |
48 | | - { |
49 | | - "host": "exemple.com" |
50 | | - } |
51 | | - ] |
52 | | - }, |
53 | | - { |
54 | | - "title": "test title with endpoints as strings", |
55 | | - "description": "Some very long description with\n\n some UTF-8 chars à qu'il est beau2", |
56 | | - "severity": "Critical", |
57 | | - "mitigation": "Some mitigation", |
58 | | - "date": "2021-01-06", |
59 | | - "cve": "CVE-2020-36235", |
60 | | - "cwe": 287, |
61 | | - "cvssv3": "CVSS:3.1/AV:N/AC:L/PR:H/UI:R/S:C/C:L/I:L/A:N", |
62 | | - "file_path": "src/two.cpp", |
63 | | - "line": 135, |
64 | | - "endpoints": [ |
65 | | - "http://urlfiltering.paloaltonetworks.com/test-command-and-control", |
66 | | - "https://urlfiltering.paloaltonetworks.com:2345/test-pest" |
67 | | - ] |
68 | | - }, |
69 | | - { |
70 | | - "title": "test title", |
71 | | - "description": "Some very long description with\n\n some UTF-8 chars à qu'il est beau2", |
72 | | - "severity": "Critical", |
73 | | - "mitigation": "Some mitigation", |
74 | | - "date": "2021-01-06", |
75 | | - "cve": "CVE-2020-36236", |
76 | | - "cwe": 287, |
77 | | - "cvssv3": "CVSS:3.1/AV:N/AC:L/PR:H/UI:R/S:C/C:L/I:L/A:N", |
78 | | - "file_path": "src/threeeeeeeeee.cpp", |
79 | | - "line": 1353 |
80 | | - } |
81 | | - ] |
82 | | -} |
83 | | -``` |
84 | | - |
85 | | -This parser supports an attributes that accept files as Base64 strings. These files are attached to the respective findings. |
86 | | - |
87 | | -Example: |
88 | | - |
89 | | -```JSON |
90 | | -{ |
91 | | - "name": "My wonderful report", |
92 | | - "findings": [ |
93 | | - { |
94 | | - "title": "Vuln with image", |
95 | | - "description": "Some very long description", |
96 | | - "severity": "Medium", |
97 | | - "files": [ |
98 | | - { |
99 | | - "title": "Screenshot from 2017-04-10 16-54-19.png", |
100 | | - "data": "iVBORw0KGgoAAAANSUhEUgAABWgAAAK0CAIAAAARSkPJAAAAA3N<...>TkSuQmCC" |
101 | | - } |
102 | | - ] |
103 | | - } |
104 | | - ] |
105 | | -} |
106 | | -``` |
107 | | - |
108 | | -This parser supports some additional attributes to be able to define custom `TestTypes` as well as influencing some meta fields on the `Test`: |
109 | | - |
110 | | -- `name`: The internal name of the tool you are using. This is primarily informational, and used for reading the report manually. |
111 | | -- `type`: The name of the test type to create in DefectDojo with the suffix of `(Generic Findings Import)`. The suffix is an important identifier for future users attempting to identify the test type to supply when importing new reports. This value is very important when fetching the correct test type to import findings into, so be sure to keep the `type` consistent from import to import! As an example, a report submitted with a `type` of `Internal Company Tool` will produce a test type in DefectDojo with the title `Internal Company Tool (Generic Findings Import)`. With this newly created test type, you can define custom `HASHCODE_FIELDS` or `DEDUPLICATION_ALGORITHM` in the settings. |
112 | | -- `version`: The version of the tool you are using. This is primarily informational, and is used for reading the report manually and tracking format changes from version to version. |
113 | | -- `description`: A brief description of the test. This could be an explanation of what the tool is reporting, where the tools is maintained, who the point of contact is for the tool when issues arise, or anything in between. |
114 | | -- `static_tool`: Dictates that tool used is running static analysis methods to discover vulnerabilities. |
115 | | -- `dynamic_tool`: Dictates that tool used is running dynamic analysis methods to discover vulnerabilities. |
116 | | -- `soc`: Dictates that tool is used for reporting alerts from a soc (Pro Edition Only). |
117 | | - |
118 | | -Example: |
119 | | - |
120 | | -```JSON |
121 | 11 | { |
122 | | - "name": "My wonderful report", |
123 | | - "type": "My custom Test type", |
124 | | - "version": "1.0.5", |
125 | | - "description": "A unicorn tool that is capable of static analysis, dynamic analysis, and even capturing soc alerts!", |
126 | | - "static_tool": true, |
127 | | - "dynamic_tool": true, |
128 | | - "soc": true, |
129 | | - "findings": [ |
130 | | - ] |
| 12 | + "name": "Example Report", |
| 13 | + "findings": [] |
131 | 14 | } |
132 | | -``` |
133 | 15 |
|
134 | | -### Sample Scan Data |
| 16 | +DefectDojo Pro users can also consider using the [Universal Parser](../universal_parser), a tool which allows for highly customizable JSON, XML and CSV imports. |
135 | 17 |
|
136 | | -Sample Generic Findings Import scans can be found [here](https://github.com/DefectDojo/django-DefectDojo/tree/master/unittests/scans/generic). |
| 18 | +For more information on supported parameters for Generic Findings Import, see the [Parser Guide](../file/generic) |
0 commit comments