diff --git a/docs/assets/images/cross_tool_deduplication.png b/docs/assets/images/cross_tool_deduplication.png new file mode 100644 index 00000000000..c1324bf238a Binary files /dev/null and b/docs/assets/images/cross_tool_deduplication.png differ diff --git a/docs/assets/images/deduplication_tuning.png b/docs/assets/images/deduplication_tuning.png new file mode 100644 index 00000000000..f1bdcaf440b Binary files /dev/null and b/docs/assets/images/deduplication_tuning.png differ diff --git a/docs/assets/images/deduplication_tuning_menu.png b/docs/assets/images/deduplication_tuning_menu.png new file mode 100644 index 00000000000..36c38e30176 Binary files /dev/null and b/docs/assets/images/deduplication_tuning_menu.png differ diff --git a/docs/assets/images/reimport_deduplication.png b/docs/assets/images/reimport_deduplication.png new file mode 100644 index 00000000000..f3ef19ee9f4 Binary files /dev/null and b/docs/assets/images/reimport_deduplication.png differ diff --git a/docs/assets/images/same_tool_deduplication.png b/docs/assets/images/same_tool_deduplication.png new file mode 100644 index 00000000000..7e93ba76519 Binary files /dev/null and b/docs/assets/images/same_tool_deduplication.png differ diff --git a/docs/content/en/about_defectdojo/pro_features.md b/docs/content/en/about_defectdojo/pro_features.md index a9ca9ea51fa..387e4b11ee6 100644 --- a/docs/content/en/about_defectdojo/pro_features.md +++ b/docs/content/en/about_defectdojo/pro_features.md @@ -12,29 +12,39 @@ DefectDojo Pro comes with many additional features. Here is list of those featu ## Improved UX ### Pro UI -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. +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. ![image](images/enabling_deduplication_within_an_engagement_2.png) ### Rules Engine DefectDojo Pro's Rules Engine allows you to set up a script of automated bulk actions - no programming experience required. -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. +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. ![image](images/rules_engine_4.png) ### Pro Dashboards and Reporting 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. +### Deduplication Tuning +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. +See our [Deduplication Tuning Guide](/en/working_with_findings/finding_deduplication/tune_deduplication/) for more information. + +![image](images/deduplication_tuning.png) + ## Streamlined import ### Background Imports For enterprise-level reports, DefectDojo Pro offers an optimized upload method which processes Findings in the background. ### CLI Tools -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. +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. ### Connectors -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. +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. ![image](images/add_edit_connectors_2.png) @@ -54,6 +64,7 @@ Supported tools for Connectors include: ### Universal Parser Are you using an unsupported or customized scanning tool? Or do you just wish DefectDojo handled a report slightly differently? -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/) +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/) for more information. ![image](images/universal_parser_3.png) diff --git a/docs/content/en/working_with_findings/finding_deduplication/tune_deduplication.md b/docs/content/en/working_with_findings/finding_deduplication/tune_deduplication.md new file mode 100644 index 00000000000..675f4cc88f3 --- /dev/null +++ b/docs/content/en/working_with_findings/finding_deduplication/tune_deduplication.md @@ -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** + +![image](images/deduplication_tuning.png) + +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 + +![image](images/same_tool_deduplication.png) + +### 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. + +![image](images/cross_tool_deduplication.png) + +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. + +![image](images/reimport_deduplication.png) + +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.