-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Pro Feature - Deduplication tuning documentation update #12471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mtesauro
merged 9 commits into
DefectDojo:bugfix
from
skywalke34:deduplication-tuning-docs-clean
Jun 3, 2025
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
11e6e1b
Update pro_features.md
skywalke34 b89f54b
Deduplication X tool Deduplication image
skywalke34 6aa6873
Initial version - Deduplication Tuning
skywalke34 8ed12a3
Deduplication Settings Menu
skywalke34 fbbb1d9
Additional screenshots for deduplication tuning
skywalke34 f902f6d
Update tune_deduplication.md
skywalke34 52112e8
Update pro_features.md
skywalke34 6acce0f
Update docs/content/en/working_with_findings/finding_deduplication/tu…
Maffooch 7dec5f3
We love the Oxford comma :)
Maffooch File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
docs/content/en/working_with_findings/finding_deduplication/tune_deduplication.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| --- | ||
| title: "Deduplication Tuning (Pro)" | ||
| description: "Configure how DefectDojo identifies and manages duplicate findings" | ||
| weight: 4 | ||
| --- | ||
|
|
||
| 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. | ||
|
|
||
| ## Deduplication Settings | ||
|
|
||
| In DefectDojo Pro, you can access Deduplication Tuning through: | ||
| **Settings > Pro Settings > Deduplication Settings** | ||
|
|
||
|  | ||
|
|
||
| The Deduplication Settings page offers three key configuration areas: | ||
| - Same Tool Deduplication | ||
| - Cross Tool Deduplication | ||
| - Reimport Deduplication | ||
|
|
||
| ## Same Tool Deduplication | ||
|
|
||
| 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. | ||
|
|
||
| To adjust Same Tool Deduplication: | ||
|
|
||
| 1. Select a specific **Security Tool** from the dropdown | ||
| 2. Choose a **Deduplication Algorithm** from the available options | ||
|
|
||
|  | ||
|
|
||
| ### Available Deduplication Algorithms | ||
|
|
||
| DefectDojo Pro offers three deduplication methods for same-tool deduplication: | ||
|
|
||
| #### Hash Code | ||
| 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. | ||
|
|
||
| #### Unique ID From Tool | ||
| Leverages the security tool's own internal identifier for findings, ensuring perfect deduplication when the scanner provides reliable unique IDs. | ||
|
|
||
| #### Unique ID From Tool or Hash Code | ||
| 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. | ||
|
|
||
| ## Cross Tool Deduplication | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| To enable Cross Tool Deduplication: | ||
|
|
||
| 1. Select a **Security Tool** from the dropdown | ||
| 2. Change the **Deduplication Algorithm** from "Disabled" to "Hash Code" | ||
| 3. Select which fields should be used for generating the hash in the **Hash Code Fields** dropdown | ||
|
|
||
| Unlike Same Tool Deduplication, Cross Tool Deduplication only supports the Hash Code algorithm, as different tools rarely share compatible unique identifiers. | ||
|
|
||
| ## Reimport Deduplication | ||
|
|
||
| Reimport Deduplication Settings are specifically designed for reimporting data using Universal Parsers or the Generic Parser. | ||
|
|
||
|  | ||
|
|
||
| When configuring Reimport Deduplication: | ||
|
|
||
| 1. Select the **Security Tool** (Universal or Generic Parser) | ||
| 2. Choose the appropriate **Deduplication Algorithm** | ||
|
|
||
| The same three algorithm options are available for Reimport Deduplication as for Same Tool Deduplication: | ||
| - Hash Code | ||
| - Unique ID From Tool | ||
| - Unique ID From Tool or Hash Code | ||
|
|
||
| ## Deduplication Best Practices | ||
|
|
||
| For optimal results with Deduplication Tuning: | ||
|
|
||
| - **Start with defaults**: The preconfigured deduplication settings work well for most scenarios | ||
| - **Test changes carefully**: After adjusting deduplication settings, monitor a few imports to ensure proper behavior. | ||
| - **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. | ||
| - **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. | ||
| - **Avoid overly broad deduplication**: Cross-tool deduplication with too few hash fields may result in false duplicates | ||
|
|
||
| By tuning deduplication settings to your specific tools, you can significantly reduce duplicate noise. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.