Skip to content

Commit 924c2c8

Browse files
authored
Merge pull request #12431 from DefectDojo/release/2.46.2
Release: Merge release into master from: release/2.46.2
2 parents 1b6e43b + c43cd15 commit 924c2c8

File tree

32 files changed

+326
-139
lines changed

32 files changed

+326
-139
lines changed

.github/workflows/release-nightly-dev.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ on:
1414
jobs:
1515
nightly-build-dev:
1616
uses: ./.github/workflows/release-x-nightly.yml
17+
if: github.repository == 'DefectDojo/django-DefectDojo' # Build (and try to push) fails in forks
1718
with:
1819
branch-to-build: 'dev'
1920
tag-to-apply: 'nightly-dev'

components/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "defectdojo",
3-
"version": "2.46.1",
3+
"version": "2.46.2",
44
"license" : "BSD-3-Clause",
55
"private": true,
66
"dependencies": {
110 KB
Loading
106 KB
Loading
159 KB
Loading
155 KB
Loading
223 KB
Loading

docs/content/en/about_defectdojo/examples_of_use.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,17 @@ Each of these report categories can be handled by a separate Engagement, with a
3636

3737
![image](images/example_product_hierarchy_bigcorp.png)
3838

39-
- If a Product has a CI/CD pipeline, all of the results from that pipeline can be continuously imported into a single open-ended Engagement. Each tool used will create a separate Test within the 'CI/CD' Engagement, which can be continuously updated with new data.
39+
- If a Product has a CI/CD pipeline, all of the results from that pipeline can be continuously imported into a single open-ended Engagement. Each tool used will create a separate Test within the 'CI/CD' Engagement, which can be continuously updated with new data.
40+
(See our guide to [Reimport](/en/connecting_your_tools/import_scan_files/using_reimport/))
4041
- Each Pen Test effort can have a separate Engagement created to contain all of the results: e.g. 'Q1 Pen Test 2024', 'Q2 Pen Test 2024', etc.
4142
- BigCorp will likely want to run their own mock PCI Audit so that they're prepared for the real thing when it happens. The results of those audits can also be stored as a separate Engagement.
4243

44+
45+
4346
#### RBAC Model
4447

4548
- Each BISO has Reader access assigned for each business unit (Product Type) that they're in charge of.
46-
- Each Product Owner has Writer access for the Product that they're in charge of. Within their Product, these Product Owners can interact with DefectDojo - they can keep notes, set up pipelines, create Risk Acceptances or use other features.
49+
- Each Product Owner has Writer access for the Product that they're in charge of. Within their Product, these Product Owners can interact with DefectDojo - they can keep notes, set up [CI/CD pipelines](/en/connecting_your_tools/import_scan_files/api_pipeline_modelling/), create Risk Acceptances or use other features.
4750
- Developers at BigCorp have no access to DefectDojo at all, and they don't need it - the Product Owner can push Jira tickets directly from DefectDojo which contain all of the relevant vulnerability information. The developers are already using Jira, so they don't have to track remediation any differently than a different development task.
4851

4952
### Embedded Systems: Version-Controlled Reporting
@@ -98,12 +101,14 @@ Key Concerns for Kate's Cloud Service:
98101

99102
#### Tagging Shared Services
100103

101-
Because Kate's model contains many shared services that can impact other Products, the team Tags the results to indicate which cloud offerings rely on those services. This allows any issues with shared services to be traced back to the relevant teams, and reports in DefectDojo. Each of these Shared Services are in a single Product Type that separates them from the main Cloud offerings.
104+
Because Kate's model contains many shared services that can impact other Products, the team [Tags](/en/working_with_findings/organizing_engagements_tests/tagging_objects/) the results to indicate which cloud offerings rely on those services. This allows any issues with shared services to be traced back to the relevant teams, and reports in DefectDojo. Each of these Shared Services are in a single Product Type that separates them from the main Cloud offerings.
102105

103106
![image](images/example_product_hierarchy_microservices.png)
104107

105108
Because the company is rapidly growing, with frequently changing tech leads, Kate can use Tags to track which tech lead is currently responsible for each cloud product, avoiding the need for constant manual updates to their DefectDojo system. These Tech Lead associations are tracked by a service that's external to DefectDojo and can govern the import pipelines or call the DefectDojo API.
106109

110+
For more information on Tagging, see our guide to [Tags](/en/working_with_findings/organizing_engagements_tests/tagging_objects/).
111+
107112
#### RBAC Model
108113

109114
On the Security/Compliance side:
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: "❓ Frequently Asked Questions"
3+
description: "DefectDojo FAQ"
4+
draft: "false"
5+
weight: 2
6+
chapter: true
7+
---
8+
9+
Here are some frequently asked questions about working with DefectDojo - both in DefectDojo Pro or DefectDojo OS.
10+
11+
## General Questions
12+
13+
### How should I organize my security testing in DefectDojo?
14+
15+
DefectDojo can support any security testing or reporting environment, but to optimize your use of DefectDojo you'll need to make sure things are in the right place.
16+
17+
There's no one-size-fits-all solution for DefectDojo, because everyone's security team and operations look different. We have a very detailed article on [common use cases](/en/about_defectdojo/examples_of_use/) that has examples of how different organizations apply RBAC and the DefectDojo data model to support their needs.
18+
19+
### What are the recommended workflows for security testing in DefectDojo?
20+
21+
DefectDojo is meant to be the central source of truth for your organization's security posture, and it can fill different needs depending on your organization's requirements:
22+
23+
- DefectDojo can enforce SLAs on vulnerabilities, ensuring that your organization handles each within an appropriate timeframe.
24+
- DefectDojo can [push tickets to Jira](/en/share_your_findings/jira_guide/), allowing your development team to integrate issue remediation into their standard release process without requiring them to learn another project management tool.
25+
- DefectDojo can be integrated into automated [CI/CD pipelines](/en/connecting_your_tools/import_scan_files/api_pipeline_modelling/) to automatically ingest report data from repositories - even down to the branch level.
26+
- DefectDojo can [create a report](/en/share_your_findings/pro_reports/using_the_report_builder/) on any set of vulnerabilities or software context, to quickly share many scan results or status updates with stakeholders.
27+
28+
DefectDojo is designed to support and standardize your current security workflow. All of these methods can be used to enhance your team's processes, depending on how you currently operate.
29+
30+
### How does DefectDojo handle access control?
31+
32+
DefectDojo can be used by large teams, and setting up [RBAC (Rule Based Access Control)](/en/customize_dojo/user_management/about_perms_and_roles/) is highly recommended, both to properly establish context for each team member, and to control access to certain parts of Infrastructure.
33+
34+
Role and permission assignment generally happens at the Product Type / Product level. Each team member can be assigned to one or more Products or Product Types, and can be given a role which governs how they can interact with the vulnerability data within (read only, read-write, or full control). For more information, see our [RBAC guide](/en/customize_dojo/user_management/about_perms_and_roles/).
35+
36+
## Import Workflows
37+
38+
### What tools are supported by DefectDojo?
39+
40+
DefectDojo supports reports from over 200 security tools, both commercial and Open Source. See our [Parser List](/en/connecting_your_tools/parsers/) for more information on these tools.
41+
42+
If you're looking to add a new tool to your suite, we have a list of recommended Open Source tools which you can check out [here](https://defectdojo.com/blog/announcing-the-defectdojo-open-source-security-awards).
43+
44+
### What is the different between Import and Reimport?
45+
46+
There are two different methods to import a report from a security tool into DefectDojo:
47+
48+
- **Import** handles the report as a single point-in-time record. Importing a report creates a Test within DefectDojo that holds the Findings rendered from that report.
49+
- **Reimport** is used to extend an existing Test. If you have a more open-ended approach to your testing process, you continuously Reimport the latest version of your report to an existing Test. DefectDojo will compare the results of the incoming report to your existing data, record any changes, and then adjust the Findings in the Test so that they match the latest report.
50+
51+
Both methods also use **Deduplication** differently: while two discrete Imported Tests in the same Product will identify and label duplicate Findings, Reimport will discard duplicate Findings altogether.
52+
53+
Generally speaking - if a point-in-time report is what you need, Import is the best method to use. If you are continuously running and ingesting reports from a tool, Reimport is the better method for keeping things organized.
54+
55+
For more information on Reimport, see our [article](/en/connecting_your_tools/import_scan_files/using_reimport/).
56+
57+
### How can I troubleshoot Import errors?
58+
59+
DefectDojo supports a wide variety of tools. If you're seeing inconsistent behavior when importing a report, we recommend checking to see if the file structure matches what the tool is expecting. See our [Parser List](/en/connecting_your_tools/parsers/) to see if your tool is supported, and check to make sure that the file format matches what the tool expects. You can also compare the structure to our Unit Tests.
60+
61+
**DefectDojo Pro** has a Universal Parser import method which allows you to handle any JSON, CSV or XML file. **DefectDojo OS** users can write custom parsers for the same purpose.
62+
63+
Finally, third-party report formats have been known to change without warning, and our Open Source community greatly appreciates [PRs and contributions](/en/open_source/contributing/how-to-write-a-parser/) to keep our parsers up to date.
64+
65+
### How should I handle large scan files?
66+
67+
Importing a large report into DefectDojo can be a lengthy process. Reports of 2MB contain substantial amounts of data which can take a long time to translate into Findings. This depends on the security tool's report format itself
68+
69+
Our recommended approach is to break a large report up before import - rather than ingesting a report of **all** a tool's vulnerabilities at once, split them up by software project, application or by another context. This makes it much easier for DefectDojo to handle and categorize the data, and has the added benefit of proactively organizing your Findings, which makes for more relevant and faster report generation.
70+
71+
**DefectDojo Pro** can process reports in the background, which makes this process easier. However, files still need to be uploaded and validated by DefectDojo before the background Finding creation process can begin.
72+
73+
### How do I connect a CI/CD pipeline to DefectDojo?
74+
75+
Many of DefectDojo's core features can be completely automated. CI/CD (or any kind of automated import) can be handled by calling the [DefectDojo REST API](/en/connecting_your_tools/import_scan_files/api_pipeline_modelling/). **DefectDojo Pro** users also have access to the **Universal Importer / DefectDojo CLI** [command-line tools](/en/connecting_your_tools/external_tools/), which can be installed to run in many automated environments.
76+
77+
## Finding Management
78+
79+
### What does the status of a Finding mean?
80+
81+
Findings can have many statuses which indicate their status. A status of Active or Inactive is always set on a Finding, while other statuses such as Verified, False Positive, or Out Of Scope can be applied at your discretion.
82+
83+
These statuses are described in more detail in our [Finding Status Definitions](/en/working_with_findings/findings_workflows/finding_status_definitions/) guide, along with information about how they can be used.
84+
85+
### How can I delete Findings from DefectDojo?
86+
87+
It's important to maintain historical records in AppSec work, so generally speaking, we recommend retaining Closed Findings as 'Inactive' rather than deleting them outright. Deleting a Finding will remove all notes and metric-tracking from that Finding outright, which can lead to inaccurate reports or an incomplete archive.
88+
89+
Findings from DefectDojo can be deleted in a few ways:
90+
- by running a [Bulk Delete](/en/working_with_findings/findings_workflows/editing_findings/#bulk-delete-findings) action on the Findings that you want to delete
91+
- by calling `DELETE /findings/{id}` through the API
92+
- by deleting a parent object, such as a Test, Engagement, Product Type or Product.
93+
94+
## Reporting and Jira
95+
96+
### How can I generate a report in DefectDojo?
97+
98+
You can quickly create a customized report in DefectDojo using the [Report Builder](/en/share_your_findings/pro_reports/using_the_report_builder/).
99+
100+
DefectDojo Pro users also have access to [executive-level Metrics dashboards](/en/about_defectdojo/ui_pro_vs_os/#new-dashboards) that can report on Product Types, Products or other data in real-time.
101+
102+
### How can I integrate Jira with DefectDojo?
103+
104+
Findings in DefectDojo can be pushed to Jira as Issues, which allows you to integrate issue remediation with your development team. We have a [complete guide to Jira](/en/share_your_findings/jira_guide/) written which describes the process in detail.

docs/content/en/about_defectdojo/pro_features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ 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 [Beta 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. See our [Pro UI Guide](../ui_pro_vs_os) for more information.
1616

1717
![image](images/enabling_deduplication_within_an_engagement_2.png)
1818

docs/content/en/about_defectdojo/ui_pro_vs_os.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ weight: 5
66
pro-feature: true
77
---
88

9-
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: The Beta UI and associated features are only available in DefectDojo Pro.</span>
9+
<span style="background-color:rgba(242, 86, 29, 0.3)">Note: The Pro UI and associated features are only available in DefectDojo Pro.</span>
1010

11-
In late 2023, DefectDojo Inc. released a new UI for DefectDojo Pro, which has since been in Beta for Pro customers to test and experiment with.
11+
In late 2023, DefectDojo Inc. released a new UI for DefectDojo Pro, which has since been in Pro for Pro customers to test and experiment with.
1212

13-
The Beta UI brings the following enhancements to DefectDojo:
13+
The Pro UI brings the following enhancements to DefectDojo:
1414

1515
- Modern and sleek design, built using Vue.js
1616
- Optimized data delivery and load times, especially for large datasets
1717
- Access to new Pro features, including [API Connectors](/en/connecting_your_tools/connectors/about_connectors/), [Universal Importer](/en/connecting_your_tools/external_tools/), and Pro Metrics views
1818
- Improved UI workflows: better filtering, dashboards, and navigation
1919

20-
## Switching To The Beta UI
20+
## Switching To The Pro UI
2121

22-
To access the Beta UI, open your User Options menu from the top-right hand corner. You can also switch back to the Classic UI from the same menu.
22+
To access the Pro UI, open your User Options menu from the top-right hand corner. You can also switch back to the Classic UI from the same menu.
2323

2424
![image](images/beta-classic-uis.png)
2525

@@ -37,7 +37,7 @@ To access the Beta UI, open your User Options menu from the top-right hand corne
3737

3838
The Enterprise settings section contains the System Settings, Jira Instances, Deduplication Settings, SAML, OAuth, Login and MFA forms.
3939

40-
5. The beta UI also has a **new table format** to help with navigation. This table is used with all [Product Hierarchy](/en/working_with_findings/organizing_engagements_tests/product_hierarchy/). Each column can be clicked on to apply a relevant filter, and columns can be reordered to present data however you like.
40+
5. The Pro UI also has a **new table format** to help with navigation. This table is used with all [Product Hierarchy](/en/working_with_findings/organizing_engagements_tests/product_hierarchy/). Each column can be clicked on to apply a relevant filter, and columns can be reordered to present data however you like.
4141

4242
6. The table also has a **"Toggle Columns"** menu which can add or remove columns from the table.
4343

@@ -48,7 +48,7 @@ In this screenshot we are filtering for all Findings that are in 'Product One'.
4848

4949
## New Dashboards
5050

51-
New metrics visualizations are included in the Beta UI. All of these reports can be filtered and exported as PDF to share them with a wider audience.
51+
New metrics visualizations are included in the Pro UI. All of these reports can be filtered and exported as PDF to share them with a wider audience.
5252

5353
![image](images/program_insights.png)
5454

0 commit comments

Comments
 (0)