Skip to content

Commit

Permalink
[DOCS-7097] Move Control Center - Security Controls from ADW to ACS d…
Browse files Browse the repository at this point in the history
…ocs (#1289)

* [DOCS-7097] Adding Security Control to ACS 23.1 and 7.4

* [DOCS-7097] Remove Control Center from ADW 4.0, 4.1, 4.2

* [DOCS-7097] Minor edits in the title

* [DOCS-7097] Add cross-link from ACS 7.4 to ADW 4.2 docs

* [DOCS-7097] Fix broken link in control-center.md

* [DOCS-7097] Add cross-link from ADW 4.0 to ACS 7.4 docs

* Add links to ACS 23.1, ADW 4.1 - 4.3

* [DOCS-7097] Remove duplicate sentence in control-center.md

---------

Co-authored-by: Adelaide Nxumalo <27953420+anxumalo@users.noreply.github.com>
  • Loading branch information
aritrihore and anxumalo authored Jan 23, 2024
1 parent 33ef118 commit ed03d54
Show file tree
Hide file tree
Showing 7 changed files with 134 additions and 244 deletions.
8 changes: 4 additions & 4 deletions _data/toc/digital-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
pages:
- title: 'Governance Services overview'
path: '/digital-workspace/latest/governance/'
- title: 'Security Controls'
- title: 'Security Marks'
path: '/digital-workspace/latest/governance/security/'
- title: 'Working with records'
path: '/digital-workspace/latest/governance/records/'
Expand Down Expand Up @@ -71,7 +71,7 @@
pages:
- title: 'Governance Services overview'
path: '/digital-workspace/4.2/governance/'
- title: 'Security Controls'
- title: 'Security Marks'
path: '/digital-workspace/4.2/governance/security/'
- title: 'Working with records'
path: '/digital-workspace/4.2/governance/records/'
Expand Down Expand Up @@ -123,7 +123,7 @@
pages:
- title: 'Governance Services overview'
path: '/digital-workspace/4.1/governance/'
- title: 'Security Controls'
- title: 'Security Marks'
path: '/digital-workspace/4.1/governance/security/'
- title: 'Working with records'
path: '/digital-workspace/4.1/governance/records/'
Expand Down Expand Up @@ -175,7 +175,7 @@
pages:
- title: 'Governance Services overview'
path: '/digital-workspace/4.0/governance/'
- title: 'Security Controls'
- title: 'Security Marks'
path: '/digital-workspace/4.0/governance/security/'
- title: 'Working with records'
path: '/digital-workspace/4.0/governance/records/'
Expand Down
59 changes: 59 additions & 0 deletions content-services/7.4/admin/control-center.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,65 @@ The category tree automatically refreshes and you can see the new category you c
A category name does not need to be unique to the Control Center, it only needs to be unique within the level it sits in within the Control Center.
## Security Controls
You can add Security Controls to files and folders so that only users with the required security level can view or access them.
These security controls are created and configured using the Control Center and are applied to your files or folders from within the Digital Workspace. The Security Controls you create are made up of Controls created in the Control Center which are in turn made up of one or more Security Marks. You can create as many Security Marks that you require within the different Controls. The names of the Controls and Security Marks you create will be unique to your organization.
There are three different ways you can configure your Controls:
* **All** = Users must have all Security Marks from the group that are applied to a file to see that file.
Example: A Security Group named Training contains Security Marks of Media and Data Handling. To see a file marked as both Media or Data Handling, a user must have both Media and Data Handling clearance.
* **Any** = Users must have at least one of the Security Marks from the group that are applied to a file to see that file.
Example: A Security Group named Nationality contains Security Marks of UK, US, and Aus. To see a file marked as UK and US, a user must have UK and / or US clearance.
* **Hierarchical** = Security Marks are ranked in the order they're created. The mark created first in a security group has the greatest clearance, the one created last the least clearance.

Example: The predefined Classification group has marks of Top Secret, Secret, and Classified. To see a file classified as Secret, the user must have Secret or Top Secret clearance.

### Security Controls in the Control Center

Use this example to create an **All** Control in the Control Center called Training that has three Security Marks, **Media**, **Data handling**, and **Backend management**.

> **Important:** All Security Marks you create are visible to all users within the Digital Workspace.

#### Create Controls and Security Marks

Use the Control Center to create Controls.

1. Log into the Control Center as an administrator.

2. Expand the **Security** entry in the left pane and then click **Security Controls**.

You can view and edit all of your Controls from here.

3. Click **Create New Control**.

4. Enter `Training` in the **Control Name** field.

5. Select **All** from the **Configuration** drop-down list.

You can see from the example diagram the user has `Mark 2` security rights. When **All** is selected from the **Configuration** drop-down list it means they can only access files or directories that only have `Mark 2` Security Marks assigned to them.

6. Click the **+** symbol next to Security Marks.

7. Enter `Media` into the new row.

8. Click the **+** symbol again next to Security Marks.

9. Enter `Data handling` into the new row.

10. Click the **+** symbol again next to Security Marks.

11. Enter `Backend management` into the new row and then click **Save**.

You have created a new Control called `Training` that has three Security Marks. The [Security Marks]({% link digital-workspace/4.2/governance/security.md %}) will be visible and useable within the Digital Workspace.

![security-controls]({% link digital-workspace/images/security-controls.png %})

## Troubleshooting

1. If you have issues running `docker-compose up` after deleting a previous Docker Compose cluster, try replacing step 4 in the initial Docker Compose instructions with:
Expand Down
59 changes: 59 additions & 0 deletions content-services/latest/admin/control-center.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,65 @@ The category tree automatically refreshes and you can see the new category you c
A category name does not need to be unique to the Control Center, it only needs to be unique within the level it sits in within the Control Center.
## Security Controls
You can add Security Controls to files and folders so that only users with the required security level can view or access them.
These security controls are created and configured using the Control Center and are applied to your files or folders from within the Digital Workspace. The Security Controls you create are made up of Controls created in the Control Center which are in turn made up of one or more Security Marks. You can create as many Security Marks that you require within the different Controls. The names of the Controls and Security Marks you create will be unique to your organization.
There are three different ways you can configure your Controls:
* **All** = Users must have all Security Marks from the group that are applied to a file to see that file.
Example: A Security Group named Training contains Security Marks of Media and Data Handling. To see a file marked as both Media or Data Handling, a user must have both Media and Data Handling clearance.
* **Any** = Users must have at least one of the Security Marks from the group that are applied to a file to see that file.
Example: A Security Group named Nationality contains Security Marks of UK, US, and Aus. To see a file marked as UK and US, a user must have UK and / or US clearance.
* **Hierarchical** = Security Marks are ranked in the order they're created. The mark created first in a security group has the greatest clearance, the one created last the least clearance.

Example: The predefined Classification group has marks of Top Secret, Secret, and Classified. To see a file classified as Secret, the user must have Secret or Top Secret clearance.

### Security Controls in the Control Center

Use this example to create an **All** Control in the Control Center called Training that has three Security Marks, **Media**, **Data handling**, and **Backend management**.

> **Important:** All Security Marks you create are visible to all users within the Digital Workspace.

#### Create Controls and Security Marks

Use the Control Center to create Controls.

1. Log into the Control Center as an administrator.

2. Expand the **Security** entry in the left pane and then click **Security Controls**.

You can view and edit all of your Controls from here.

3. Click **Create New Control**.

4. Enter `Training` in the **Control Name** field.

5. Select **All** from the **Configuration** drop-down list.

You can see from the example diagram the user has `Mark 2` security rights. When **All** is selected from the **Configuration** drop-down list it means they can only access files or directories that only have `Mark 2` Security Marks assigned to them.

6. Click the **+** symbol next to Security Marks.

7. Enter `Media` into the new row.

8. Click the **+** symbol again next to Security Marks.

9. Enter `Data handling` into the new row.

10. Click the **+** symbol again next to Security Marks.

11. Enter `Backend management` into the new row and then click **Save**.

You have created a new Control called `Training` that has three Security Marks. The [Security Marks]({% link digital-workspace/latest/governance/security.md %}) will be visible and useable within the Digital Workspace.

![security-controls]({% link digital-workspace/images/security-controls.png %})

## Troubleshooting

1. If you have issues running `docker-compose up` after deleting a previous Docker Compose cluster, try replacing step 4 in the initial Docker Compose instructions with:
Expand Down
63 changes: 3 additions & 60 deletions digital-workspace/4.0/governance/security.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,7 @@
---
title: Security Controls
title: Security Marks
---

You can add Security Controls to files and folders so that only users with the required security level can view or access them.
These security controls are created and configured using the Control Center and are applied to your files or folders from within the Digital Workspace. The Security Controls you create are made up of Controls created in the Control Center which are in turn made up of one or more Security Marks. You can create as many Security Marks that you require within the different Controls. The names of the Controls and Security Marks you create will be unique to your organization.

There are three different ways you can configure your Controls:

* **All** = Users must have all Security Marks from the group that are applied to a file to see that file.

Example: A Security Group named Training contains Security Marks of Media and Data Handling. To see a file marked as both Media or Data Handling, a user must have both Media and Data Handling clearance.

* **Any** = Users must have at least one of the Security Marks from the group that are applied to a file to see that file.

Example: A Security Group named Nationality contains Security Marks of UK, US, and Aus. To see a file marked as UK and US, a user must have UK and / or US clearance.

* **Hierarchical** = Security Marks are ranked in the order they're created. The mark created first in a security group has the greatest clearance, the one created last the least clearance.

Example: The predefined Classification group has marks of Top Secret, Secret, and Classified. To see a file classified as Secret, the user must have Secret or Top Secret clearance.

## Security Controls in the Control Center

Use this example to create an **All** Control in the Control Center called Training that has three Security Marks, **Media**, **Data handling**, and **Backend management**.

> **Important:** All Security Marks you create are visible to all users within the Digital Workspace.
### Create Controls and Security Marks

Use the Control Center to create Controls.

1. Log into the Control Center as an administrator.

2. Expand the **Security** entry in the left pane and then click **Security Controls**.

You can view and edit all of your Controls from here.

3. Click **Create New Control**.

4. Enter `Training` in the **Control Name** field.

5. Select **All** from the **Configuration** drop-down list.

You can see from the example diagram the user has `Mark 2` security rights. When **All** is selected from the **Configuration** drop-down list it means they can only access files or directories that only have `Mark 2` Security Marks assigned to them.

6. Click the **+** symbol next to Security Marks.

7. Enter `Media` into the new row.

8. Click the **+** symbol again next to Security Marks.

9. Enter `Data handling` into the new row.

10. Click the **+** symbol again next to Security Marks.

11. Enter `Backend management` into the new row and then click **Save**.

You have created a new Control called Training that has three Security Marks. The Security Marks will be visible and useable within the Digital Workspace.

![security-controls]({% link digital-workspace/images/security-controls.png %})

## Security Marks in the Digital Workspace

Use the Digital Workspace to assign Security Marks to files and folders. Doing this limits their accessibility from users that do not have the correct user rights.

1. Sign into the Digital Workspace.
Expand All @@ -76,3 +17,5 @@ Use the Digital Workspace to assign Security Marks to files and folders. Doing t
Once you have saved the Security Marks for the file or folder the ones you have selected will be visible in the Security Marks column.

> **Note:** If you have more than can be displayed in the column you can click the **Display all** button.
See the [Security Controls]({% link content-services/7.4/admin/control-center.md %}#security-controls) section of the Content Services - Control Center documentation for more details.
63 changes: 3 additions & 60 deletions digital-workspace/4.1/governance/security.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,7 @@
---
title: Security Controls
title: Security Marks
---

You can add Security Controls to files and folders so that only users with the required security level can view or access them.
These security controls are created and configured using the Control Center and are applied to your files or folders from within the Digital Workspace. The Security Controls you create are made up of Controls created in the Control Center which are in turn made up of one or more Security Marks. You can create as many Security Marks that you require within the different Controls. The names of the Controls and Security Marks you create will be unique to your organization.

There are three different ways you can configure your Controls:

* **All** = Users must have all Security Marks from the group that are applied to a file to see that file.

Example: A Security Group named Training contains Security Marks of Media and Data Handling. To see a file marked as both Media or Data Handling, a user must have both Media and Data Handling clearance.

* **Any** = Users must have at least one of the Security Marks from the group that are applied to a file to see that file.

Example: A Security Group named Nationality contains Security Marks of UK, US, and Aus. To see a file marked as UK and US, a user must have UK and / or US clearance.

* **Hierarchical** = Security Marks are ranked in the order they're created. The mark created first in a security group has the greatest clearance, the one created last the least clearance.

Example: The predefined Classification group has marks of Top Secret, Secret, and Classified. To see a file classified as Secret, the user must have Secret or Top Secret clearance.

## Security Controls in the Control Center

Use this example to create an **All** Control in the Control Center called Training that has three Security Marks, **Media**, **Data handling**, and **Backend management**.

> **Important:** All Security Marks you create are visible to all users within the Digital Workspace.
### Create Controls and Security Marks

Use the Control Center to create Controls.

1. Log into the Control Center as an administrator.

2. Expand the **Security** entry in the left pane and then click **Security Controls**.

You can view and edit all of your Controls from here.

3. Click **Create New Control**.

4. Enter `Training` in the **Control Name** field.

5. Select **All** from the **Configuration** drop-down list.

You can see from the example diagram the user has `Mark 2` security rights. When **All** is selected from the **Configuration** drop-down list it means they can only access files or directories that only have `Mark 2` Security Marks assigned to them.

6. Click the **+** symbol next to Security Marks.

7. Enter `Media` into the new row.

8. Click the **+** symbol again next to Security Marks.

9. Enter `Data handling` into the new row.

10. Click the **+** symbol again next to Security Marks.

11. Enter `Backend management` into the new row and then click **Save**.

You have created a new Control called Training that has three Security Marks. The Security Marks will be visible and useable within the Digital Workspace.

![security-controls]({% link digital-workspace/images/security-controls.png %})

## Security Marks in the Digital Workspace

Use the Digital Workspace to assign Security Marks to files and folders. Doing this limits their accessibility from users that do not have the correct user rights.

1. Sign into the Digital Workspace.
Expand All @@ -76,3 +17,5 @@ Use the Digital Workspace to assign Security Marks to files and folders. Doing t
Once you have saved the Security Marks for the file or folder the ones you have selected will be visible in the Security Marks column.

> **Note:** If you have more than can be displayed in the column you can click the **Display all** button.
See the [Security Controls]({% link content-services/7.4/admin/control-center.md %}#security-controls) section of the Content Services - Control Center documentation for more details.
Loading

0 comments on commit ed03d54

Please sign in to comment.