Skip to content

Commit a1ad3e1

Browse files
committed
update with examples, views, Locations info
1 parent d261564 commit a1ad3e1

2 files changed

Lines changed: 35 additions & 6 deletions

File tree

docs/content/asset_modelling/components/PRO__components.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,15 @@ weight: 1
77

88
In DefectDojo, Components represent third-party libraries, software components, and modules that potentially have vulnerabilities.
99

10-
## The Component Table
10+
* DefectDojo Pro has introduced a beta feature called **Locations**, which will eventually consolidate and Components and Endpoints.
11+
12+
## Component Views
13+
14+
DefectDojo Pro includes a dedicated table view for Components, which can be found in the sidebar. This view shows Active Findings, Duplicate Findings, and Total Findings for each Component. These figures include all Assets on the DefectDojo instance.
1115

12-
DefectDojo Pro includes a dedicated table view for Components. Imported Components remain on the table even if all of their associated Findings are Mitigated. When Findings are imported for a specific Component, the Component Table is updated to accurately reflect the new Finding totals.
16+
An individual Asset's Components can be seen on the Asset view.
17+
18+
## The Component Table
1319

1420
The Component Table displays the following columns:
1521

@@ -19,15 +25,38 @@ The Component Table displays the following columns:
1925
* **Duplicate Findings** — count of Duplicate Findings associated with the component.
2026
* **Total Findings** — total count of all Findings associated with the component.
2127

22-
The totals for Active Findings, Duplicate Findings, and Total Findings are calculated from the Findings on the instance.
23-
2428
Clicking on the Component Name or the values for Active Findings, Duplicate Findings, or Total Findings opens a filtered list of Findings for the respective field.
2529

2630
A **None** Component is displayed on the table, which shows all Findings that are not associated with any Component.
2731

32+
Imported Components remain on the table even if all of their associated Findings are Mitigated. When Findings are imported for a specific Component, the Component Table is updated to accurately reflect the new Finding totals.
33+
34+
35+
### Example
36+
37+
A Component imported from a Dependency-Check scan against an application with a vulnerable `lodash` dependency might appear on the table as:
38+
39+
| Component | Version | Active Findings | Duplicate Findings | Total Findings |
40+
| --- | --- | --- | --- | --- |
41+
| npm:lodash | 4.17.15 | 3 | 1 | 5 |
42+
43+
Clicking `npm:lodash` opens the list of every Finding that references this Component. Clicking `3` opens the same list filtered to Active Findings only.
44+
2845
## Adding Components
2946

30-
Components can be added from a scan import or by manually editing a Finding. Once a Component Name is associated with a Finding, it is added to the Component Table. If the Component is already associated with other Findings on the instance, the totals for Active Findings, Duplicate Findings, and Total Findings are updated accordingly.
47+
Components can be parsed from a scan import or by manually editing a Finding. Once a Component Name is associated with a Finding, a corresponding entry will be added to the Component Table automatically. If the Component is already associated with other Findings in DefectDojo, the totals for Active Findings, Duplicate Findings, and Total Findings are updated accordingly.
48+
49+
### How Components are Parsed from Scan Data
50+
51+
When a scan is imported, parsers populate the **Component Name** and **Component Version** fields on each Finding from the scan output. The Component Table is then built from those values. The level of detail and the naming convention depend on the tool that produced the scan:
52+
53+
* **Software Composition Analysis (SCA) tools** typically report a package name and exact version. For example, OWASP Dependency-Check derives the Component from the [Package URL](https://github.com/package-url/purl-spec) in its identifier — a `pkg:npm/lodash@4.17.15` purl becomes `Component Name: npm:lodash`, `Component Version: 4.17.15`.
54+
* **Container and OS package scanners** such as Trivy, Anchore Grype, and Anchore Engine report the affected OS or language package — for example, `Component Name: curl`, `Component Version: 7.68.0`.
55+
* **Language-specific dependency scanners** such as npm Audit, pip-audit, bundler-audit, Retire.js, Govulncheck, and OSV-Scanner populate the offending package and version from their respective ecosystem manifests.
56+
57+
Scanners focused on configuration, infrastructure, or source-code logic (such as SAST and IaC tools) generally do not populate the Component fields, and their Findings appear under the **None** Component.
58+
59+
To add or change a Component manually, edit the Finding and set the **Component Name** and **Component Version** fields directly. The Component Table updates as soon as the Finding is saved.
3160

3261
## Updating Components
3362

docs/content/asset_modelling/components/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Components"
2+
title: "Components & Endpoints"
33
date: 2021-02-02T20:46:29+01:00
44
draft: false
55
type: docs

0 commit comments

Comments
 (0)