Skip to content

Commit d261564

Browse files
Jino-Tclaude
andcommitted
docs: add Components page and glossary entry
Adds a new Pro-only Components page under Model Your Assets > Components covering the Component Table, and how to add, update, and remove components. Also adds a Component entry to the glossary. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent bd1a39b commit d261564

3 files changed

Lines changed: 52 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Components"
3+
description: "Tracking third-party libraries and software components in DefectDojo Pro"
4+
audience: pro
5+
weight: 1
6+
---
7+
8+
In DefectDojo, Components represent third-party libraries, software components, and modules that potentially have vulnerabilities.
9+
10+
## The Component Table
11+
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.
13+
14+
The Component Table displays the following columns:
15+
16+
* **Component** — the name of the component, populated from scan data.
17+
* **Version** — the component version, populated from scan data.
18+
* **Active Findings** — count of Active Findings associated with the component.
19+
* **Duplicate Findings** — count of Duplicate Findings associated with the component.
20+
* **Total Findings** — total count of all Findings associated with the component.
21+
22+
The totals for Active Findings, Duplicate Findings, and Total Findings are calculated from the Findings on the instance.
23+
24+
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.
25+
26+
A **None** Component is displayed on the table, which shows all Findings that are not associated with any Component.
27+
28+
## Adding Components
29+
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.
31+
32+
## Updating Components
33+
34+
To update a Component Name or Version, all Findings associated with the Component must have their Component Name or Component Version field updated.
35+
36+
## Removing Components
37+
38+
To remove a Component from the Component Table, all Findings associated with the Component must be updated to remove their Component Name and Component Version fields. Components are also removed if all of their associated Findings are deleted.
39+
40+
If all of a Component's Findings are Mitigated, the Component remains on the table but its Active Findings value is set to 0.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Components"
3+
date: 2021-02-02T20:46:29+01:00
4+
draft: false
5+
type: docs
6+
weight: 4
7+
sidebar:
8+
collapsed: false
9+
exclude_search: true
10+
---

docs/content/help/glossary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ A scoped security activity representing a testing window, pipeline, or assessmen
1919
A single execution of a scanner or manual assessment within an Engagement. Tests store execution metadata and act as the ingestion point for Findings.
2020
## Service (Both)
2121
An optional sub-object used to attribute Findings to a specific component or interface within an Asset. Services are most useful in OS DefectDojo, as their functionality is replicated and enhanced by Asset Hierarchy in the Pro version.
22+
## Components (Both)
23+
A third-party library, software module, or external dependency that is tracked in DefectDojo Pro. Imported Components are derived from scan data and associated with Findings. In the Pro UI, the Component Table aggregates Active, Duplicate, and Total Finding counts per Component and remains populated even when all associated Findings are Mitigated.
2224
## Finding (Both)
2325
The most granular vulnerability object in DefectDojo's Product Hierarchy that represents a discrete security issue.
2426
### Finding Status (Both)

0 commit comments

Comments
 (0)