Skip to content

Commit 7fa98e6

Browse files
Merge pull request #10079 from mendix/kk-works-security
Workstation security best practices
2 parents 6885c9c + d20b177 commit 7fa98e6

5 files changed

Lines changed: 56 additions & 2 deletions

File tree

content/en/docs/workstation/wks-build-app.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Building an App for Mendix Workstation"
3+
linktitle: "Building an App"
34
url: /mendix-workstation/build-app/
45
description: "Describes how to install the Workstation Connector and build an app to work with Mendix Workstation."
56
weight: 30

content/en/docs/workstation/wks-installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Installing and Configuring Mendix Workstation"
3+
linktitle: "Installation and Configuration"
34
url: /mendix-workstation/installation/
45
description: "Documents the installation process for Mendix Workstation."
56
weight: 20

content/en/docs/workstation/wks-prerequisites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Getting Started with Mendix Workstation"
3+
linktitle: "Getting Started"
34
url: /mendix-workstation/prerequisites/
45
description: "Documents the requirements for the Mendix Workstation."
56
weight: 10
@@ -50,8 +51,7 @@ As you begin your work with Mendix Workstation, keep in mind the following best
5051

5152
### Security Recommendations
5253

53-
* Regularly update the Workstation Client to the latest version.
54-
* Enable security in your Mendix app and assign the appropriate roles to the modules to ensure proper access control.
54+
For more information, see [Security Best Practices for Mendix Workstation](/mendix-workstation/security/).
5555

5656
### Performance Optimization
5757

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Security Best Practices for Mendix Workstation"
3+
linktitle: "Security Best Practices"
4+
url: /mendix-workstation/security/
5+
description: "Provides information about best-practice security configuration for the Mendix Workstation."
6+
weight: 15
7+
---
8+
9+
## Introduction
10+
11+
Security is one of the most important aspects of a deployment, because misconfiguration or failing security can have large consequences. The Mendix Workstation Client gives many configuration options for permissions that can have an impact on the security of your deployment.
12+
13+
This document describes the common aspects you should consider when deploying the Mendix Workstation Client in production.
14+
15+
## Assignment of Workspace Roles {#workspace-roles}
16+
17+
Workspace roles should be assigned following the principle of least privilege. Always grant users the minimum permissions necessary for them to successfully complete their tasks. You can reassign the roles at any time if responsibilities change. To help maintain a secure deployment, consider the following guidelines:
18+
19+
* Assign the View Only role to untrusted users.
20+
* Use caution when granting the Workspace Admin role.
21+
* Workspace Admins can unintentionally disrupt production, for example by deleting an app or modifying its public key.
22+
* Workspace Admins can allow Workstation Clients to access malicious apps.
23+
* Conduct regular permissions audits to make sure that temporary privilege elevations are reverted once they are no longer necessary.
24+
25+
## Station Set Up {#setup-stations}
26+
27+
Setting up stations involves a variety of options, some of which have important security implications. To help ensure a secure deployment, follow these best practices:
28+
29+
* Keep stations lean by disabling unused apps and deleting unused devices.
30+
* Any unused device represents a potential attack surface (for example, a forgotten card reader that leaks a token, or a TCP device that exposes a device on the network).
31+
* Any unused but enabled app may gain unintended access to devices that were not meant to be exposed to it.
32+
* Verify that all devices configured on a station are safe for all enabled applications.
33+
* Devices are shared across all applications in a station. If a device should not be accessible by a particular app, it should not be present on that station.
34+
* Configure File devices carefully.
35+
* File devices are powerful and can pose security risks if misconfigured.
36+
* Restrict the allowed folder and permissions as much as possible. The Workstation Client enforces these restrictions within the allowed folder and its subfolders.
37+
38+
## Access Restrictions for the Configuration Folder on Microsoft Windows {#config-access}
39+
40+
By default, the Windows global installer for the Workstation Client grants the **BUILTIN\Users** Windows user group read and write access to the *ProgramData/Mendix Workstation* folder. This configuration is safe in most cases. However, for highly sensitive environments, you may want to restrict write access for the built-in Users group, and instead delegate permissions to a different group.
41+
42+
### Why Restrict the Users Group?
43+
44+
The **BUILTIN\Users** group includes all standard user accounts on the system. Restricting its write access helps prevent the following:
45+
46+
* Compromised accounts modifying configuration files
47+
* Unauthorized users deregistering the station, temporarily halting production
48+
49+
By delegating permissions to a more tightly controlled group, you ensure that only authorized accounts have the ability to modify the configuration and to use the Workstation Client.
50+
51+
To delegate permissions to a custom group, create a new Windows user group and grant it the same permissions to the *C:\ProgramData\Mendix Workstation* folder as are currently held by the Users group. After that, you can remove the Users group or adjust its permissions as needed. For more information about managing groups and permissions, refer to Microsoft Windows documentation.

content/en/docs/workstation/wks-troubleshooting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Troubleshooting Mendix Workstation"
3+
linktitle: "Troubleshooting"
34
url: /mendix-workstation/troubleshooting/
45
description: "Describes how to solve potential issues with Mendix Workstation."
56
weight: 40

0 commit comments

Comments
 (0)