diff --git a/docs/assets/images/osregulations_ss1.png b/docs/assets/images/osregulations_ss1.png new file mode 100644 index 00000000000..6b29af3659d Binary files /dev/null and b/docs/assets/images/osregulations_ss1.png differ diff --git a/docs/assets/images/osregulations_ss2.png b/docs/assets/images/osregulations_ss2.png new file mode 100644 index 00000000000..590af584599 Binary files /dev/null and b/docs/assets/images/osregulations_ss2.png differ diff --git a/docs/assets/images/osregulations_ss3.png b/docs/assets/images/osregulations_ss3.png new file mode 100644 index 00000000000..513238e497f Binary files /dev/null and b/docs/assets/images/osregulations_ss3.png differ diff --git a/docs/assets/images/regulations_ss1.png b/docs/assets/images/regulations_ss1.png new file mode 100644 index 00000000000..8435ac59b40 Binary files /dev/null and b/docs/assets/images/regulations_ss1.png differ diff --git a/docs/assets/images/regulations_ss2.png b/docs/assets/images/regulations_ss2.png new file mode 100644 index 00000000000..0a98d0e14ba Binary files /dev/null and b/docs/assets/images/regulations_ss2.png differ diff --git a/docs/assets/images/regulations_ss3.png b/docs/assets/images/regulations_ss3.png new file mode 100644 index 00000000000..eb6d47f96f4 Binary files /dev/null and b/docs/assets/images/regulations_ss3.png differ diff --git a/docs/content/asset_modelling/engagements_tests/OS__calendar.md b/docs/content/asset_modelling/engagements_tests/OS__calendar.md index 35b52c55a05..4ddb1ba6d41 100644 --- a/docs/content/asset_modelling/engagements_tests/OS__calendar.md +++ b/docs/content/asset_modelling/engagements_tests/OS__calendar.md @@ -1,6 +1,6 @@ --- title: "Calendar" -description: "How to use the Calendar in DefectDojo Pro" +description: "How to use the Calendar in DefectDojo OS" audience: opensource weight: 9 --- diff --git a/docs/content/asset_modelling/engagements_tests/OS__regulations.md b/docs/content/asset_modelling/engagements_tests/OS__regulations.md new file mode 100644 index 00000000000..fe9027712bd --- /dev/null +++ b/docs/content/asset_modelling/engagements_tests/OS__regulations.md @@ -0,0 +1,69 @@ +--- +title: "Regulations" +description: "Understanding Regulations in DefectDojo OS" +audience: opensource +weight: 7 +--- +**Regulations** provide a registry of regulatory and compliance frameworks relevant to an organization. They can be associated with Assets to identify the regulatory frameworks that apply to them. Examples of Regulations include GDPR, HIPAA, PCI DSS, and SOX. + +Regulations are useful for: +- **Compliance reference**: Maintain information about regulatory frameworks that apply to an organization. +- **Organization**: Centralize regulatory and compliance information within DefectDojo. +- **Reference**: Link to an external source for additional information about a regulation. + +Importantly, **Regulations serve only as reference information** and do not themselves assess Findings for compliance or enforce regulatory requirements. Rather, they identify the regulatory frameworks applicable to each Asset. + +### Accessing Regulations + +Regulations are accessible from within the Configuration submenu of the sidebar. + +![image](images/osregulations_ss1.png) + +### Permissions + +All Users can view the list of existing Regulations, regardless of their global role. + +However, the ability to create, edit, and delete Regulations is limited to Superusers. + +More information about permissions can be found [here](/admin/user_management/os__authorized_users/). + +## Regulation Data + +Regulations include the following fields: + +- **Regulation name**: The full name of the Regulation. +- **Acronym**: The commonly used acronym for the Regulation. +- **Category**: Privacy, Finance, Education, Medical, Corporate, and Other. +- **Jurisdiction**: The jurisdiction in which the Regulation applies. +- **Description**: A description of the Regulation and its purpose. +- **Reference**: A URL linking to an external source for additional information about the Regulation (e.g., Wikipedia or the Regulation's official source page). + +## Working with Regulations + +### Creating Regulations + +Regulations can be created by clicking **Add Regulation** from within the settings dropdown in the upper-right corner of the Regulations view. From there, enter information for all required fields and click **Submit** to create the Regulation. + +### Editing Regulations + +Regulations can be edited by clicking on the Regulation name. Change any desired information and then click Update. + +### Deleting Regulations + +Regulations can be deleted by clicking on the Regulation name and selecting **Delete** on the ensuing page. + +As noted previously, the ability to create, edit, and delete Regulations is reserved only for Superusers. + +## Associating Regulations with Assets + +Regulations can be associated with an Asset using the **Regulations** section within an Asset’s settings. To access an Asset's settings, click **Settings** in the Asset’s top bar and select **Edit**. + +The Regulations dropdown lists all active Regulations in your instance. Select any Regulations that apply to the Asset and click **Submit**. + +![image](images/osregulations_ss2.png) + +Once submitted, any applicable Regulations will appear within the Regulations table in the Asset's view. + +![image](images/osregulations_ss3.png) + +Associating a Regulation with an Asset provides regulatory context for the Asset but does not perform compliance assessments or automatically evaluate its Findings. diff --git a/docs/content/asset_modelling/engagements_tests/PRO__regulations.md b/docs/content/asset_modelling/engagements_tests/PRO__regulations.md new file mode 100644 index 00000000000..95d6c7fc66c --- /dev/null +++ b/docs/content/asset_modelling/engagements_tests/PRO__regulations.md @@ -0,0 +1,69 @@ +--- +title: "Regulations" +description: "Understanding Regulations in DefectDojo Pro" +audience: pro +weight: 7 +--- +**Regulations** provide a registry of regulatory and compliance frameworks relevant to an organization. They can be associated with Assets to identify the regulatory frameworks that apply to them. Examples of Regulations include GDPR, HIPAA, PCI DSS, and SOX. + +Regulations are useful for: +- **Compliance reference**: Maintain information about regulatory frameworks that apply to an organization. +- **Organization**: Centralize regulatory and compliance information within DefectDojo. +- **Reference**: Link to an external source for additional information about a regulation. + +Importantly, **Regulations serve only as reference information** and do not themselves assess Findings for compliance or enforce regulatory requirements. Rather, they identify the regulatory frameworks applicable to each Asset. + +### Accessing Regulations + +Regulations are accessible from within the Configuration submenu of the sidebar. + +![image](images/regulations_ss1.png) + +### Permissions + +All Users can view the list of existing Regulations, regardless of their global role. + +However, the ability to create, edit, and delete Regulations is limited to Superusers. + +More information about permissions and global roles can be found [here](/admin/user_management/pro_permissions_overhaul/). + +## Regulation Data + +Regulations include the following fields: + +- **Regulation name**: The full name of the Regulation. +- **Acronym**: The commonly used acronym for the Regulation. +- **Category**: Privacy, Finance, Education, Medical, Corporate, and Other. +- **Jurisdiction**: The jurisdiction in which the Regulation applies. +- **Description**: A description of the Regulation and its purpose. +- **Reference**: A URL linking to an external source for additional information about the Regulation (e.g., Wikipedia or the Regulation's official source page). + +## Working with Regulations + +### Creating Regulations + +Regulations can be created by clicking the **New Regulation** button in the upper left corner of the Regulations view. From there, enter information for all required fields and click **Submit** to create the Regulation. + +### Editing Regulations + +Regulations can be edited by clicking the ⋮ kebab icon to the left of the desired Regulation and selecting **Edit Regulation** from the dropdown menu. + +### Deleting Regulations + +Regulations can be deleted by clicking the ⋮ kebab icon to the left of the desired Regulation and selecting **Delete Regulation** from the dropdown menu. + +As noted previously, the ability to create, edit, and delete Regulations is reserved only for Superusers. + +## Associating Regulations with Assets + +Regulations can be associated with an Asset using the **Optional Fields** section within an Asset’s settings. To access an Asset's settings, click **Edit Asset** from within the gear menu in the upper-right corner of the Asset's view. + +The Regulations dropdown menu lists all active Regulations in your instance. Select any Regulations that apply to the Asset and click **Submit**. + +![image](images/regulations_ss2.png) + +Once submitted, any applicable Regulations will appear within the Regulations subsection of the **Asset Overview** table in the Asset's view. + +![image](images/regulations_ss3.png) + +Associating a Regulation with an Asset provides regulatory context for the Asset but does not perform compliance assessments or automatically evaluate its Findings. \ No newline at end of file