Include analysis.detail in DefectDojo finding payload#6181
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
8fbff52 to
e9e8bfb
Compare
|
Hi @webdevred, please re-target your PR at either |
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
…S column shift Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
…LL_FINDINGS Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
e9e8bfb to
70c2170
Compare
There was a problem hiding this comment.
Please bump the FPF version accordingly:
And add an entry for the change here:
dependency-track/docs/_docs/integrations/file-formats.md
Lines 29 to 40 in fadd195
There was a problem hiding this comment.
Hi,
Thanks for the feedback!
What do you think of this entry?
Finding Packaging Format v1.4 is not yet available in a stable release of Dependency-Track
It adds an optionaldetailfield toanalysisobjects, which contains any analyst notes recorded against the finding.
Best regards,
webdevred
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Signed-off-by: webdevred <148627186+webdevred@users.noreply.github.com>
Description
When DefectDojo is used as the primary triage surface and Dependency-Track as the SBOM ingestion engine, the per-finding audit text stored in
analysis.detailnever made it into the payload sent to DefectDojo. Auditors working in DefectDojo had no way to see that context without switching back to DT for every finding.This adds
ANALYSIS."DETAILS"to the SQL queries that back the Finding model, which makes the field flow into the Finding Packaging Format document that the DefectDojo integration uploads. The field appears asanalysis.detailalongside the existinganalysis.stateandanalysis.isSuppressedfields.One option considered was prepending the audit detail directly to
vulnerability.descriptionin the FPF, which would have made it visible in DefectDojo without any changes on that side. That was rejected becausevulnerability.descriptionis CVE data and mixing analyst notes into it would affect any other consumer of the FPF. Adding it as a separate field keeps the concerns separated and lets each consumer decide how to present it. A companion PR to DefectDojo appends it to the finding description there.One pre-existing bug is also fixed here: after the new column was inserted at position 36, the
QUERY_ALL_FINDINGScall site inFindingsSearchQueryManagerwas reading the project UUID from the wrong index. This would have caused a runtime failure in the global findings view for any project with a finding that has audit detail set.Related to DefectDojo/django-DefectDojo#14931
Addressed issue
Closes #6169
Checklist