Skip to content
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

Release: Merge back 2.42.2 into bugfix from: master-into-bugfix/2.42.2-2.43.0-dev #11608

Merged
merged 6 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/assets/images/DD-Architecture.drawio

This file was deleted.

Binary file added docs/assets/images/DD-Architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/beta-classic-uis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/beta-ui-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/program_insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file removed docs/assets/svgs/.gitkeep
Empty file.
3 changes: 0 additions & 3 deletions docs/assets/svgs/DD-Architecture.svg

This file was deleted.

53 changes: 53 additions & 0 deletions docs/content/en/about_defectdojo/ui_pro_vs_os.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "🎨 Beta UI Features"
description: "Working with different UIs in DefectDojo"
draft: "false"
weight: 4
pro-feature: true
---

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

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.

The Beta UI brings the following enhancements to DefectDojo:

- Modern and sleek design, built using Vue.js
- Optimized data delivery and load times, especially for large datasets
- 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
- Improved UI workflows: better filtering, dashboards, and navigation

## Switching To The Beta UI

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.

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

## Navigational Changes

![image](images/beta-ui-overview.png)

1. The **Sidebar** has been reorganized: Pro Metrics and the Homepage can be found in the first section.

2. Import methods can be found in the **Import** section: set up [API Connectors](/en/connecting_your_tools/connectors/about_connectors/), use the Import Scan form to [Add Findings](/en/connecting_your_tools/import_scan_files/import_scan_ui/), or use [Smart Upload](/en/connecting_your_tools/import_scan_files/smart_upload/) to handle infrastructure scanning tools.

3. The **Manage** section allows you to view different objects in the [Product Hierarchy](/en/working_with_findings/organizing_engagements_tests/product_hierarchy/), with views for Product Types, Products, Engagements, Tests, Findings, Risk Acceptances, Endpoints and Components.

4. The **Settings** section allows you to configure your DefectDojo instance, including your License, Cloud Settings, Users, Feature Configuration and admin-level Enterprise Settings.

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

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.

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

## New Dashboards

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.

![image](images/program_insights.png)

- The **Executive Insights** dashboard displays the current state of your Products and Product Types.
- **Program Insights** dashboard displays the effectiveness of your security team and the cost savings associated with separating duplicates and false positives from actionable Findings.
- **Remediation Insights** displays your effectiveness at remediating Findings.
- **Tool Insights** displays the effectiveness of your tool suite (and Connectors pipelines) at detecting and reporting vulnerabilities.
3 changes: 0 additions & 3 deletions docs/content/en/api/api-v2-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ draft: false
weight: 2
---




DefectDojo\'s API is created using [Django Rest
Framework](http://www.django-rest-framework.org/). The documentation of
each endpoint is available within each DefectDojo installation at
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,23 @@ Both an account’s Personal Notifications and the global System Notifications c

![image](images/Configure_System_&_Personal_Notifications_2.png)

To set destinations for system wide email notifications (Email, Slack or MS Teams), see our [Guide](../email_slack_teams).
To set destinations for system wide email notifications (Email, Slack or MS Teams), see our [Guide](../email_slack_teams).

## Template Notifications

Superusers also have access to a "Template" form. The Template Form allows you to set the default Personal Notifications that are enabled for any new user.

## Where System Notifications Are Sent

System notifications will be sent to:
- the single email address specified in System Settings (if enabled)
- any DefectDojo users with accounts and appropriate RBAC permissions
- the System-wide Slack or Teams account.

As with any notification in DefectDojo, System Notifications will only be sent to users that have access to the relevant data. So even if Product Notifications are set up System-Wide, users will only receive notifications for the Products that they have access to view.

This restriction does not apply to System Notifications that are sent to a specific Email or Slack channel.

See our guide on [Role-Based Access Control](../../user_management/about_perms_and_roles/) for more information on RBAC and setting permissions.

However, the connected System Email, Slack and Teams accounts cannot apply RBAC as they are not associated with a specific DefectDojo user. **All selected system-wide notifications will be sent to these locations, so you should ensure that these channels can only be accessed by specific people in your organization.**
3 changes: 2 additions & 1 deletion docs/content/en/open_source/archived_docs/usage/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ title: "Core data classes"
description: "DefectDojo is made to be flexible to conform to your program, rather than making your team conform to the tool."
draft: false
weight: 1
exclude_search: true
---

{{ readFile "/docs/assets/svgs/DD-Hierarchy.svg" | safeHTML }}
![image](images/dd-hierarchy.png)

## Product Type

Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/open_source/installation/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ draft: false
weight: 1
---

{{ readFile "/docs/assets/svgs/DD-Architecture.svg" | safeHTML }}
![image](images/dd-architecture.png)

## NGINX

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,19 @@ Jira settings are located near the bottom of the Product Settings page.

![image](images/Add_a_Connected_Jira_Project_to_a_Product_2.png)

#### **Jira Instance**
### Jira Instance

If you have multiple instances of Jira set up, for separate products or teams within your organization, you can indicate which Jira Project you want DefectDojo to create Issues in. Select a Project from the drop\-down menu.

If this menu doesn't list any Jira instances, confirm that those Projects are connected in your global Jira Configuration for DefectDojo \- yourcompany.defectdojo.com/jira.

#### **Project key**
### Project key

This is the key of the Project that you want to use with DefectDojo. The Project Key for a given project can be found in the URL.

![image](images/Add_a_Connected_Jira_Project_to_a_Product_3.png)

#### **Issue template**
### Issue template

Here you can determine how much DefectDojo metadata you want to send to Jira. Select one of two options:

Expand All @@ -65,7 +65,7 @@ Here is an example of a **jira\_full** Issue:

![image](images/Add_a_Connected_Jira_Project_to_a_Product_5.png)

#### **Component**
### Component

If you manage your Jira project using Components, you can assign the appropriate Component for DefectDojo here.

Expand All @@ -87,19 +87,23 @@ Select the relevant labels that you want the Issue to be created with in Jira, e

![image](images/Add_a_Connected_Jira_Project_to_a_Product_6.png)

#### **Default assignee**
### Default assignee

The name of the default assignee in Jira. If left blank, DefectDojo will follow the default behaviour in your Jira Project when creating Issues.

#### Checkbox options
## Additional Jira Options

![image](images/Add_a_Connected_Jira_Project_to_a_Product_7.png)
### Enable Connection With Jira Project

#### **Add vulnerability Id as a Jira label**
Jira integrations can be removed from your instance only if no related Issues have been created. If Issues have been created, there is no way to completely remove a Jira Instance from DefectDojo.

However, you can disable your Jira integration by disabling it at the Product level. This will not delete or change any existing Jira tickets created by DefectDojo, but will disable any further updates.

### Add Vulnerability Id as a Jira label

This allows you to add the Vulnerability ID data as a Jira Label automatically. Vulnerability IDs are added to Findings from individual security tools \- these may be Common Vulnerabilities and Exposures (CVE) IDs or a different format, specific to the tool reporting the Finding.

#### **Enable engagement epic mapping**
### Enable Engagement Epic Mapping

In DefectDojo, Engagements represent a collection of work. Each Engagement contains one or more tests, which contain one or more Findings which need to be mitigated. Epics in Jira work in a similar way, and this checkbox allows you to push Engagements to Jira as Epics.

Expand All @@ -110,21 +114,21 @@ In DefectDojo, Engagements represent a collection of work. Each Engagement conta

![image](images/Add_a_Connected_Jira_Project_to_a_Product_9.png)

#### **Push All Issues**
### Push All Issues

If checked, DefectDojo will automatically push any Active and Verified Findings to Jira as Issues. If left unchecked, all Findings will need to be pushed to Jira manually.

#### **Push notes**
### Push Notes

If enabled, Jira comments will populate on the associated Finding in DefectDojo, under Notes on the issue(screenshot), and vice versa; Notes on Findings will be added to the associated Jira Issue as Comments.

#### **Send SLA notifications as comment?**
### Send SLA Notifications As Comments

If enabled, any Issue which breaches DefectDojo’s Service Level Agreement rules will have comments added to the Jira issue indicating this. These comments will be posted daily until the Issue is resolved.

Service Level Agreements can be configured under **Configuration \> SLA Configuration** in DefectDojo and assigned to each Product.

#### **Send Risk Acceptance expiration notifications as comment?**
### Send Risk Acceptance Expiration Notifications As Comment?

If enabled, any Issue where the associated DefectDojo Risk Acceptance expires will have a comment added to the Jira issue indicating this. These comments will be posted daily until the Issue is resolved.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,14 @@ If this doesn’t work correctly, it could be due to a Firewall issue on your Ji

* DefectDojo's Firewall Rules include a checkbox for **Jira Cloud,** which needs to be enabled before DefectDojo can receive Webhook messages from Jira.

## Disconnecting from Jira

Jira integrations can be removed from your instance only if no related Issues have been created. If Issues have been created, there is no way to completely remove a Jira Instance from DefectDojo.

However, you can disable your Jira integration by disabling it at the Product level. From the **Edit Product** form (Classic UI) or from the **Jira Product Settings** (Beta UI) you can uncheck the "Enable Connection With Jira Project" option. This will not delete or change any existing Jira tickets created by DefectDojo, but will disable any further updates.

See our guide on [Adding Jira To a Product](../jira_integration/add_jira_to_product) for more information on Product-level settings.

## Next steps

* Now that you've set up your Jira Configuration, **[link it to one or more of your Products](../add_jira_to_product)** to have your Findings populate into Jira.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Troubleshooting Jira errors"
description: "Set up a Jira Configuration in DefectDojo - step 1 of working with Jira"
description: "Fixing issues with a Jira integration"
---

Here are some common issues with the Jira integration, and ways to address them.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ weight: 2
Once you have created one or more **Reports** in DefectDojo you can take further actions, including:

* Using a report as a template for subsequent reports

* Re-running a report with updated data

* Deleting an old or unused report

![image](images/Working_with_Generated_Reports.png)
Expand Down
2 changes: 1 addition & 1 deletion dojo/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
# Django starts so that shared_task will use this app.
from .celery import app as celery_app # noqa: F401

__version__ = "2.42.1"
__version__ = "2.42.2"
__url__ = "https://github.com/DefectDojo/django-DefectDojo"
__docs__ = "https://documentation.defectdojo.com"
2 changes: 1 addition & 1 deletion helm/defectdojo/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: "2.43.0-dev"
description: A Helm chart for Kubernetes to install DefectDojo
name: defectdojo
version: 1.6.169-dev
version: 1.6.170-dev
icon: https://www.defectdojo.org/img/favicon.ico
maintainers:
- name: madchap
Expand Down
Loading