Skip to content

Commit 5311b14

Browse files
committed
fix the readme format for the verifier
1 parent 2a90b6d commit 5311b14

1 file changed

Lines changed: 28 additions & 42 deletions

File tree

docs/content/en/connecting_your_tools/parsers/file/reversinglabs_spectraassure.md

Lines changed: 28 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ toc_hide: true
55

66
# ReversingLabs SpectraAssure Parser
77

8-
## File Types
8+
### File Types
99

1010
The parser accepts only `report.rl.json` files.
1111
You can find instructions how to export the `rl-json` report from the cli and portal scanners.
@@ -16,63 +16,54 @@ You can find instructions how to export the `rl-json` report from the cli and po
1616
- [docker:rl-scanner-cloud](https://hub.docker.com/r/reversinglabs/rl-scanner-cloud).
1717

1818

19-
## Relevant Fields in report.rl.json
19+
### Total Fields in Reversinglabs Spectra Assure rl-json
2020

21-
The format of the `rl-json` report is shown in:
21+
For the specification of the rl-json report, see the documentation at:
2222

23+
- [rl-json-schema](https://docs.secure.software/cli/rl-json-schema)
2324
- [analysis-reports:rl-json](https://docs.secure.software/concepts/analysis-reports#rl-json).
2425

25-
The RlJsonInfo module is the principal parser vor the `report.rl.json` data.
26-
The primary focus is on extracting vulnerabilities (CVE) that occur on rl-json `components` and rl-json `dependencies`. All items without vulnerabilities are currently ignored.
2726

28-
All data is stored only once in the rl-json file and it uses references to map relevant related data:
27+
### Field Mapping Details
2928

30-
Component -> Vulnerabilities
31-
Component -> Dependencies -> Vulnerabilities
29+
#### Title
3230

33-
During the parsing we follow the references and add each item to a individual `CveInfoNode` record that has the vulnerablity and the component and the dependency data.
34-
35-
The `CveInfoNode` basically maps almost directly to the `DefectDojo Finding`.
36-
37-
The `title` and `description` are build using the collected data.
38-
39-
### Title
40-
41-
#### Component
31+
##### Component
4232

4333
For a Components, the title shows:
4434

4535
- the CVE.
4636
- the type: `Component`.
4737
- the `purl` of the `Component` if present, otherwise name and version.
48-
- the component-name.
49-
- the component-sha256.
5038

51-
The sha256 is added as sometimes a file scan my have multiple items with the same name and version but with a different hash.
52-
Typically this happens with multi language windows installeres.
5339

54-
#### Dependency
40+
##### Dependency
5541

5642
The title shows the:
5743

5844
- the CVE.
5945
- the type: `Dependecy`.
6046
- the `purl` of the `Dependency` if present, otherwise name and version.
6147

62-
### Description
48+
#### Description
49+
50+
##### Component
51+
52+
For a component we repeat the title, but add the sha256.
6353

64-
#### Component
54+
The sha256 is added as sometimes a file scan my have multiple items with the same name and version
55+
but with a different hash.
56+
Typically this happens with Windows intstall packages with multiple languages.
6557

66-
For a component we repeat the title.
6758

68-
#### Dependency
59+
##### Dependency
6960

70-
For a dependency we repeat the title and then add the component_name and component_hash.
61+
For a dependency we repeat the title and then add the component_name, the component path and the component_hash.
7162
For duplicates we add one additional line to the description for each duplicate, showing its title and component.
7263

73-
### Vulnerabilities
64+
#### Vulnerabilities
7465

75-
From the vulnerability we fetch:
66+
From the vulnerability data in the rl-json file, we fetch:
7667

7768
- the CVE unique id
7869
- cvss version
@@ -86,27 +77,22 @@ From the cvss.basescore we map the severity into:
8677
- High
8778
- Critical
8879

89-
### Other
90-
91-
We extract the scan date and the scanner version and set a static scanner-name.
92-
93-
## Field Mapping Details
94-
80+
##### Notes
9581

9682
- Currently no endpoints are created
97-
98-
- On detecting a duplicate `dependency` we increment the number of occurrences.
83+
- Deduplication is done with the `unique-id-from-tool` field.
84+
- for component: `<component sha256>:<cve>`
85+
- for dependencies: `<component sha256>:<cve>:<dependency purl>`
86+
- On detecting a duplicate `dependency` we increment the number of occurrences.<br/>
9987
`Components` have no duplicates so the nr of occurrences is always 1.
100-
101-
- Deduplication is done only on Dependencies and we use the title (cve + dependency_name and version) + the `component-path` as the hash_key to detect duplicates.
102-
10388
- The default severity if no mapping is matched is `Info`.
89+
- We extract the scan date and the scanner version and set a static scanner-name.
10490

105-
## Sample Scan Data or Unit Tests
91+
### Sample Scan Data or Unit Tests
10692

10793
- [Sample Scan Data Folder](https://github.com/DefectDojo/django-DefectDojo/tree/master/unittests/scans/reversinglabs_spectraassure)
10894

109-
## Link To Tools
95+
### Link To Tool
11096

11197
- [Spectra Assure Cli](https://docs.secure.software/cli/)
11298
- [Spectra Assure Portal](https://docs.secure.software/portal/)

0 commit comments

Comments
 (0)