Skip to content

Commit 4731d08

Browse files
skywalke34Maffoochhblankenship
authored
Pro Feature - Deduplication tuning documentation update (#12471)
* Update pro_features.md Add Deduplication Tuning section and link to X-tool deduplication screenshot. * Deduplication X tool Deduplication image image showing cross-tool deduplication screenshot * Initial version - Deduplication Tuning documentation of deduplication tuning * Deduplication Settings Menu * Additional screenshots for deduplication tuning Same tool, cross tool, reimport deduplication screenshots with menu selection. * Update tune_deduplication.md Added additional information about retroactive execution of deduplication adjustments. * Update pro_features.md Cleaned up language about deduplication, increase technical specificity + less markety. Added newlines for "See our guide for more information" . Some had it / others didn't - easier navigation visually & to links for more info. * Update docs/content/en/working_with_findings/finding_deduplication/tune_deduplication.md * We love the Oxford comma :) Co-authored-by: Harold Blankenship <36673698+hblankenship@users.noreply.github.com> --------- Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com> Co-authored-by: Harold Blankenship <36673698+hblankenship@users.noreply.github.com>
1 parent 926519b commit 4731d08

File tree

7 files changed

+101
-5
lines changed

7 files changed

+101
-5
lines changed
93.2 KB
Loading
93.5 KB
Loading
34.8 KB
Loading
81 KB
Loading
71.4 KB
Loading

docs/content/en/about_defectdojo/pro_features.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,39 @@ DefectDojo Pro comes with many additional features. Here is list of those featu
1212
## Improved UX
1313

1414
### Pro UI
15-
DefectDojo's UI has been reworked in DefectDojo Pro to be faster, more functional and to be better at navigating through enterprise-level data volume. It also includes a dark mode. See our [Pro UI Guide](../ui_pro_vs_os) for more information.
15+
DefectDojo's UI has been reworked in DefectDojo Pro to be faster, more functional, and to be better at navigating through enterprise-level data volume. It also includes a dark mode.
16+
See our [Pro UI Guide](../ui_pro_vs_os) for more information.
1617

1718
![image](images/enabling_deduplication_within_an_engagement_2.png)
1819

1920
### Rules Engine
2021
DefectDojo Pro's Rules Engine allows you to set up a script of automated bulk actions - no programming experience required.
21-
Build custom workflows and bulk actions to handle Findings and other objects. See our [Rules Engine Guide](/en/customize_dojo/rules_engine) for more info.
22+
Build custom workflows and bulk actions to handle Findings and other objects.
23+
See our [Rules Engine Guide](/en/customize_dojo/rules_engine) for more info.
2224

2325
![image](images/rules_engine_4.png)
2426

2527
### Pro Dashboards and Reporting
2628
Generate [instant reports and metrics](../ui_pro_vs_os/#new-dashboards) to share the security posture of your apps and repos. Evaluate your security tools and your team's performance in addressing security issues.
2729

30+
### Deduplication Tuning
31+
Fine-tune how DefectDojo identifies and manages duplicate findings with advanced deduplication settings. Adjust same-tool, cross-tool, and reimport deduplication for precision matching between all your chosen security tools and vulnerability findings.
32+
See our [Deduplication Tuning Guide](/en/working_with_findings/finding_deduplication/tune_deduplication/) for more information.
33+
34+
![image](images/deduplication_tuning.png)
35+
2836
## Streamlined import
2937

3038
### Background Imports
3139
For enterprise-level reports, DefectDojo Pro offers an optimized upload method which processes Findings in the background.
3240

3341
### CLI Tools
34-
Quickly build a command-line pipeline to import, reimport and export data to your DefectDojo Pro instance using our Universal Importer and DefectDojo CLI apps. These tools are maintained by the DefectDojo Pro team and can be run in Windows, Macintosh or Linux environments. See our [External Tools Guide](/en/connecting_your_tools/external_tools/) for more information.
42+
Quickly build a command-line pipeline to import, reimport, and export data to your DefectDojo Pro instance using our Universal Importer and DefectDojo CLI apps. These tools are maintained by the DefectDojo Pro team and can be run in Windows, Macintosh, or Linux environments.
43+
See our [External Tools Guide](/en/connecting_your_tools/external_tools/) for more information.
3544

3645
### Connectors
37-
DefectDojo can instantly connect to supported tools to import new Finding data - get an automated Import pipeline working out-of-the-box, without the need to set up any API calls or cron jobs. See our [Connectors Guide](/en/connecting_your_tools/connectors/about_connectors/) for more information.
46+
DefectDojo can instantly connect to supported tools to import new Finding data - get an automated Import pipeline working out-of-the-box, without the need to set up any API calls or cron jobs.
47+
See our [Connectors Guide](/en/connecting_your_tools/connectors/about_connectors/) for more information.
3848

3949
![image](images/add_edit_connectors_2.png)
4050

@@ -54,6 +64,7 @@ Supported tools for Connectors include:
5464
### Universal Parser
5565
Are you using an unsupported or customized scanning tool? Or do you just wish DefectDojo handled a report slightly differently?
5666

57-
Use DefectDojo Pro's Universal Parser to turn any .json or .csv report into an actionable set of Findings, and have DefectDojo parse the data however you like. See our [Universal Parser Guide](/en/connecting_your_tools/parsers/universal_parser/)
67+
Use DefectDojo Pro's Universal Parser to turn any .json or .csv report into an actionable set of Findings, and have DefectDojo parse the data however you like.
68+
See our [Universal Parser Guide](/en/connecting_your_tools/parsers/universal_parser/) for more information.
5869

5970
![image](images/universal_parser_3.png)
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: "Deduplication Tuning (Pro)"
3+
description: "Configure how DefectDojo identifies and manages duplicate findings"
4+
weight: 4
5+
---
6+
7+
Deduplication Tuning is a DefectDojo Pro feature that gives you fine-grained control over how findings are deduplicated, allowing you to optimize duplicate detection for your specific security testing workflow.
8+
9+
## Deduplication Settings
10+
11+
In DefectDojo Pro, you can access Deduplication Tuning through:
12+
**Settings > Pro Settings > Deduplication Settings**
13+
14+
![image](images/deduplication_tuning.png)
15+
16+
The Deduplication Settings page offers three key configuration areas:
17+
- Same Tool Deduplication
18+
- Cross Tool Deduplication
19+
- Reimport Deduplication
20+
21+
## Same Tool Deduplication
22+
23+
Same Tool Deduplication is enabled by default for all security tool parsers. This ensures findings from consecutive scans using the same tool are properly deduplicated.
24+
25+
To adjust Same Tool Deduplication:
26+
27+
1. Select a specific **Security Tool** from the dropdown
28+
2. Choose a **Deduplication Algorithm** from the available options
29+
30+
![image](images/same_tool_deduplication.png)
31+
32+
### Available Deduplication Algorithms
33+
34+
DefectDojo Pro offers three deduplication methods for same-tool deduplication:
35+
36+
#### Hash Code
37+
Uses a combination of selected fields to generate a unique hash. When selected, a third dropdown will appear showing the fields being used to calculate the hash.
38+
39+
#### Unique ID From Tool
40+
Leverages the security tool's own internal identifier for findings, ensuring perfect deduplication when the scanner provides reliable unique IDs.
41+
42+
#### Unique ID From Tool or Hash Code
43+
Attempts to use the tool's unique ID first, then falls back to the hash code if no unique ID is available. This provides the most flexible deduplication option.
44+
45+
## Cross Tool Deduplication
46+
47+
Cross Tool Deduplication is disabled by default, as deduplication between different security tools requires careful configuration due to variations in how tools report the same vulnerabilities.
48+
49+
![image](images/cross_tool_deduplication.png)
50+
51+
To enable Cross Tool Deduplication:
52+
53+
1. Select a **Security Tool** from the dropdown
54+
2. Change the **Deduplication Algorithm** from "Disabled" to "Hash Code"
55+
3. Select which fields should be used for generating the hash in the **Hash Code Fields** dropdown
56+
57+
Unlike Same Tool Deduplication, Cross Tool Deduplication only supports the Hash Code algorithm, as different tools rarely share compatible unique identifiers.
58+
59+
## Reimport Deduplication
60+
61+
Reimport Deduplication Settings are specifically designed for reimporting data using Universal Parsers or the Generic Parser.
62+
63+
![image](images/reimport_deduplication.png)
64+
65+
When configuring Reimport Deduplication:
66+
67+
1. Select the **Security Tool** (Universal or Generic Parser)
68+
2. Choose the appropriate **Deduplication Algorithm**
69+
70+
The same three algorithm options are available for Reimport Deduplication as for Same Tool Deduplication:
71+
- Hash Code
72+
- Unique ID From Tool
73+
- Unique ID From Tool or Hash Code
74+
75+
## Deduplication Best Practices
76+
77+
For optimal results with Deduplication Tuning:
78+
79+
- **Start with defaults**: The preconfigured deduplication settings work well for most scenarios
80+
- **Test changes carefully**: After adjusting deduplication settings, monitor a few imports to ensure proper behavior.
81+
- **Adjustments to deduplication will retroactively adjust the hash values for findings already imported for the given test type that was changed**. The recalculation is applied in the background to all findings in the database associated with the given test type that was changed. Please note that since the process is occurring in the background, immediate changes may not be observed.
82+
- **Use Hash Code for cross-tool deduplication**: When enabling cross-tool deduplication, select fields that reliably identify the same finding across different tools (such as vulnerability name, location, and severity). **IMPORTANT** Each tool enabled for cross-tool deduplication **MUST** have the same fields selected.
83+
- **Avoid overly broad deduplication**: Cross-tool deduplication with too few hash fields may result in false duplicates
84+
85+
By tuning deduplication settings to your specific tools, you can significantly reduce duplicate noise.

0 commit comments

Comments
 (0)