Changes for page eMagiz Security Guide

Last modified by Waria on 2026/06/04 13:44

From 12.1 to 11.1 From 45.1 to 44.1

From version 44.1

edited by Waria
on 2026/06/04 12:10

Change comment: There is no comment for this version

To version 12.1

edited by marijn
on 2022/06/13 09:34

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)
Attachments (0 modified, 7 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,0 @@
1		-eMagiz Security Guide

Parent

...	...	@@ -1,1 +1,0 @@
1		-WebHome

Author

@@ -1,1 +1,1 @@
--XWiki.waria
++XWiki.marijn

Content

@@ -1,8 +1,19 @@
--{{container}}{{container layoutStyle="columns"}}(((
--In this fundamental, we will delve into the security perspective of the eMagiz landscape. We'll explore the cloud setup, data protection, and more to understand the role security plays in each part of the eMagiz architecture. Let's dive in!
++{{html wiki="true"}}
++<div class="ez-academy">
++    <div class="ez-academy_body">
++<div class="doc">
++
++
++= eMagiz Security Guide =
++
++In this fundamental, we will zoom in on how the various parts of the eMagiz landscape can be viewed from a Security perspective. We will look at the Cloud, on-premises, data within eMagiz, external communication, and the portal during our journey. After this journey, you should have a solid understanding of what role security plays in each of the parts of the eMagiz architecture. Note that protecting your data is a joint responsibility between eMagiz and you. This fundamental aims to clarify the security measures eMagiz has taken in the eMagiz platform. This way, you can assess the eventual additional steps you need to take to ensure that the eMagiz service cooperates securely with the rest of your application and integration landscape.
++
  Should you have any questions, please get in touch with academy@emagiz.com.
++* Last update: February 17th, 2022
++* Required reading time: 15 minutes
++
  == 1. Prerequisites ==
  * Some context on cloud functionality will be helpful.
@@ -10,41 +10,37 @@
  == 2. Key concepts ==
  * Protecting your data is a joint responsibility between eMagiz and you
--* The registry containing deployable flows is read-only for clients
++* The repository is read-only for clients
  * Data in the Cloud is kept within your VPC
--* The portal is behind an MFA check
++* Production data in the portal is behind an MFA check
++
++
  == 3. eMagiz Security Guide ==
--In this fundamental, we will zoom in on how the various parts of the eMagiz landscape can be viewed from a Security perspective. We will look at the Cloud, on-premises, data within eMagiz, external communication, and the portal during our journey. After this journey, you should have a solid understanding of what role security plays in each of the parts of the eMagiz architecture. Note that protecting your data is a joint responsibility between eMagiz and you. This fundamental aims at clarifying the security measures eMagiz has taken in the eMagiz platform. This way, you can assess the eventual additional steps you need to take to ensure that the eMagiz service cooperates securely with the rest of your application and integration landscape.
++In this fundamental, we will zoom in on how the various parts of the eMagiz landscape can be viewed from a Security perspective. We will look at the Cloud, on-premises, data within eMagiz, external communication, and the portal during our journey. After this journey, you should have a solid understanding of what role security plays in each of the parts of the eMagiz architecture. Note that protecting your data is a joint responsibility between eMagiz and you. This fundamental aims to clarify the security measures eMagiz has taken in the eMagiz platform. This way, you can assess the eventual additional steps you need to take to ensure that the eMagiz service cooperates securely with the rest of your application and integration landscape.
  === 3.1 Architectural setup eMagiz ===
  eMagiz consists of various components communicating to develop the process layer and subsequently run the message layer as secure and stable as possible for our customers.
--
--1. In the eMagiz integration project, various flows are created that work together to realize the integration. The different types are shown on the top of the picture below: Entries, exits, offramps, onramps, and routing flows.
--2. Your customized flows are combined with a base image (which contains framework components to make the flows work) and are deployed into a runtime (java-based application container).
++1. In the eMagiz integration project, various flows are created that work together to realize the integration. The different types are shown on the top of the picture below: Entry, Exits, Offramps, onramps, and routing flows.
++2. These flows are then deployed together with a specific build number (contains framework components to make these flows work) into a runtime (java based application container).
 . These runtimes run on Cloud machines that contain Cloud templates (all required components to make the Cloud machine operational such as OS, Java runtime version, and more).
++The top part of the picture depicts the eMagiz repository. All relevant (open-source) libraries needed to run flows on a connector are stored within this repository.
--Your flows are stored within a registry so deployments can be managed efficiently. To prevent unauthorized access to this repository, the following measures have been taken:
++To prevent unauthorized access to this repository, the following measures have been taken
++* Client runtimes can access the repository via a username/password combination through a one-way SSL connection (encrypted) and read the contents of the repository
++* eMagiz developers that need to upload bundles can access the repository through a one-way SSL connection (encrypted)
++* A bitbucket pipeline will be created soon to enable automatic updates. This data pipeline will also need a unique username/password combination along with the fact that the connection itself is a one-way SSL connection (encrypted)
++* The repository is read-only for clients. This means that even if someone gets their hands on a username/password combination, they do not have sufficient rights to alter anything in the repository. They can only read the data that is kept in the repository.
--* Deploy agents can access the registry and can read the contents belonging to your eMagiz integration project only.
--* Client runtimes can read specific flows within the registry as provided by the deploy agent to deploy the flows
--* When running your eMagiz integration project in the cloud, security during communication between eMagiz and the registry is taken care of by the eMagiz cloud.
--* When running your eMagiz integration project on-premises, you will have to make sure that your server is running Docker and the eMagiz deploy agent so the server can access the registry successfully and securely. Learn more about this here: [[eMagiz Deploy Agent>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.eMagiz Deploy agent.WebHome||target="blank"]]
--* A bitbucket pipeline can access the registry to update the provided base image that is needed to run all your flows. This pipeline cannot access your flows, only the libraries used to build your flows.
--* Connections to the registry are always one-way SSL (encrypted) and all access is secured with a unique username/password combination.
--* As mentioned above, the registry is read-only for agents and client runtimes. This means that even if someone gets their hands on a username/password combination, they do not have sufficient rights to alter anything in the registry. They can only read the data that is kept in the registry.
++<p align="center">[[image:fundamental-emagiz-security-guide--definition-emagiz-model.png||]]</p>
++=== 3.2 Security Guidelines * Cloud ===
--
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--definition-emagiz-model.png]]
--
--=== 3.2 Security Guidelines - Cloud ===
--
  In this section, we take a closer look at the cloud setup in general. Here we will focus on high-level security measurements because we already specified security measurements at the data level.
  ==== 3.2.1 Cloud setup ====
@@ -52,7 +52,7 @@
  The picture below shows a standard double-lane setup of an eMagiz instance within the eMagiz Cloud. A single-lane design looks similar but only consists of one core machine.
  This gives insight into how messages flow through the Cloud, which measures are taken for monitoring and auto-healing, and where data is temporarily stored 'in transit.'
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-cloud-inner-workings--customer-level-overview-double-lane.png]]
++<p align="center">[[image:fundamental-emagiz-cloud-inner-workings--customer-level-overview-double-lane.png||]]</p>
  We want to use this picture to explain specific components within the Cloud from a security perspective. We will start at the outside and work our way inwards.
@@ -79,7 +79,7 @@
  * Monitoring
  * Notification options
--Making sure you are on the latest cloud template version guards yourself against vulnerabilities in older versions of Java and OS, for example. In addition, it gives the user more options for monitoring the health of the cloud environment reducing the risk of a loss of availability of data (promptly) without compromising the integrity of the data. For more information on what cloud templates are and how to control and update them, please check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Novice.eMagiz Cloud Management.novice-emagiz-cloud-management-cloud-templates-explained||target="blank"]].
++Making sure you are on the latest cloud template version guards yourself against vulnerabilities in older versions of Java and OS, for example. In addition, it gives the user more options for monitoring the health of the cloud environment reducing the risk of a loss of availability of data (promptly) without compromising the integrity of the data. For more information on what cloud templates are and how to control and update them, please check out this [microlearning](../microlearning/novice-emagiz-cloud-management-cloud-templates-explained.md).
  ==== 3.2.5 Carwash ====
@@ -123,7 +123,7 @@
  Support engineers can see more to analyze problems on a lower level.
--All other users don't have access to the cloud setup as there is no need for access because they can perform the relevant actions on the Cloud via the eMagiz portal. For more information on how please see the [[eMagiz Cloud Management>>doc:Main.eMagiz Academy.Microlearnings.Novice.eMagiz Cloud Management.WebHome||target="blank"]] course.
++All other users don't have access to the cloud setup as there is no need for access because they can perform the relevant actions on the Cloud via the eMagiz portal. For more information on how please see the [eMagiz Cloud Management](../microlearning/novice-emagiz-cloud-management-index) course.
  ===== 3.3.2.1 Rights for installing =====
@@ -141,7 +141,7 @@
  Let us first look at the data "in transit." This is the process phase where data is interchanged between flows within the eMagiz platform. This data interchange goes (i.e., from entry to onramp or offramp to exit) via the orchestration of the JMS server on the messaging layer. This is nicely shown in the picture below.
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--data-orchestration.png]]
++<p align="center">[[image:fundamental-emagiz-security-guide--data-orchestration.png||]]</p>
  Data "in transit" is temporarily stored on an encrypted filesystem with the help of encryption algorithms.
  For the Cloud, eMagiz uses the AES-256 encryption algorithm.
@@ -180,25 +180,28 @@
  ==== 3.5.2 API Gateway ====
--A structure with roles and rights per role can be specified within the portal or via an external IDP to secure the front end of the API Gateway in eMagiz. For the backend of the API Gateway, the same logic applies as stated above for messaging, which means that eMagiz supports the industry standard. Therefore, you as a user should confer with the external party about the correct method.
++A structure with roles and rights per role can be specified within the portal or via an external IDP to secure the front end of the API Gateway in eMagiz.
  ===== 3.5.2.1 Portal =====
  As you can see in the picture shown below, the roles are defined so that the Read role can only access two integrations available for this specific API Gateway. If a client has insufficient rights, they will receive a 401 Unauthorized
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--api-gateway-portal-feedback.png]]
++<p align="center">[[image:fundamental-emagiz-security-guide--api-gateway-portal-feedback.png||]]</p>
--===== 3.5.2.2 (External) IDP =====
++===== 3.5.2.2 External IDP =====
--Apart from configuring the roles, users, and rights within the portal itself, it is also possible to hook the API Gateway up to an (external) IDP.
++Apart from configuring the roles, users, and rights within the portal itself, it is also possible to hook the API Gateway up to an external IDP.
  By communicating with this IDP via the OAuth2.0 protocol, a check is done every time a client calls a specific operation to see whether that client has sufficient rights to access the operation.
  If the client has sufficient rights, the process continues. For example, if the client has insufficient rights, the client receives a 401 Unauthorized.
++For the backend of the API Gateway, the same logic applies as stated above for messaging, which means that eMagiz supports the industry standard. Therefore, you as a user should confer with the external party about the correct method.
++
  ===== 3.5.2.3 Error handling =====
  To prevent the error message if it occurs is sent straight back to the client, you can configure the front end of the API Gateway, so that correct HTTP Status codes are given back to the client, including a descriptive message.
--For more information on how this precisely can be configured via the eMagiz platform, please check the following [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-roles-and-users||target="blank"]].
++For more information on how this precisely can be configured via the eMagiz platform, please check the following [microlearning](../microlearning/crashcourse-api-gateway-configure-roles-and-users.md)
++
  ==== 3.5.3 Event Streaming ====
  Within the Event Streaming solution, eMagiz provides Event Streaming users, and topics can be created.
@@ -210,9 +210,8 @@
  These are all security measures to prevent third parties from getting unauthorized access to the data stored on the topics.
--For more information on how this precisely can be configured via the eMagiz platform, please check the following [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-user-management||target="blank"]].
++For more information on how this precisely can be configured via the eMagiz platform, please check the following [microlearning](../microlearning/crashcourse-eventstreaming-user-management.md)
--
  === 3.6 eMagiz iPaaS Portal ===
  The eMagiz portal provides access to users to manage their eMagiz integration configurations. It provides access to all the features to develop, deploy and manage integrations across Test, Acceptance, and Production environments.
@@ -221,8 +221,8 @@
  ===== 3.6.1.1 User access to https://my.emagiz.com =====
--Users can be added with their email address by the eMagiz Partner Manager or by their company contact, upon which the user gets an email to sign in. A temporary password is created and emailed, which has to be changed at the first login to the iPaaS portal. In addition, users are connected to organizations in eMagiz.
--In the administration section of the user, upon first login an MFA configuration needs to be executed by the user so they can access models to which they have been granted rights. Typical authenticators on a smartphone can be used, such as Google Authenticator. For more information, check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-security-add-mfa.WebHome||target="blank"]]. An MFA response is required for model owners to manage the permissions on a model level. See the following sections for more details on these functions.
++Users can be added with their email address by the eMagiz Partner Manager, upon which the user gets an email to sign in. A temporary password is created and emailed, which has to be changed at the first login to the iPaaS portal. In addition, users are connected to organizations in eMagiz.
++In the administration section of the user, an MFA token can be used to enable the Multifactor Authentication on a user level. Typical authenticators on a smartphone can be used, such as Google Authenticator. An MFA response is required for model owners to manage the permissions on a project level and any Edit activity in Production environments. See the following sections for more details on these functions.
  ===== 3.6.1.2 Users access to Integration Projects =====
@@ -230,7 +230,7 @@
  ===== 3.6.1.3 User authorizations to Integration projects. =====
--Every integration project has a model owner who can distribute rights across functionalities and environments. The picture below shows the various options available across the Integration Life Cycle (ILM) Phases Capture through Manage. In addition, the model owner manages the user permissions and needs to have the MFA authentication level passed before making any changes (which is asked of the model owner upon login).
++Every integration project has a model owner who can distribute rights across functionalities and environments. The picture below shows the various options available across the Integration Life Cycle (ILM) Phases Capture through Manage. In addition, the model owner manages the user permissions and needs to have the MFA authentication level passed before making any changes.
  * When Edit permission is granted on an ILM phase, all the sub-options are configurable
  * View rights mean that all options can be viewed only
@@ -238,7 +238,7 @@
  * Model owners are assigned to integration projects by eMagiz Administrators
  * An audit trail is kept of the changes made in the project permission structure
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--access-rights.png]]
++<p align="center">[[image:fundamental-emagiz-security-guide--access-rights.png||]]</p>
  ===== 3.6.1.4 Partner user access to Client environments =====
@@ -259,9 +259,9 @@
  * In all the relevant parts of the integration project, developers can version the changes made. The type (major, minor, or patch) can be indicated and commented on to describe the change. Once the version is created, that particular version will be available for Deployment and is then kept in the history of changes on a low level. Both are illustrated in the pictures below.
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--create-new-version.png]]
++<p align="center">[[image:fundamental-emagiz-security-guide--create-new-version.png||]]</p>
--[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--history-pages.png]]
++<p align="center">[[image:fundamental-emagiz-security-guide--history-pages.png||]]</p>
  * On a CDM level, the same functionality exists to indicate the version type incl. comments. All changes to the CDM model are logged in an audit trail that can help understand what changes are made by who in case of error resolution. The CDM is also protected by the permission structure of the Integration project.
@@ -303,12 +303,11 @@
  ==== 3.8.4 Data management ====
--For more information on the conceptual ideas behind data management within the eMagiz platform, you can look at this [[fundamental>>doc:Main.eMagiz Academy.Fundamentals.fundamental-traceability-in-emagiz||target="blank"]]. For more concrete information on how to implement it within an eMagiz flow you could check out this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-data-sink||target="blank"]] and this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-long-term-archiving||target="blank"]]. All the information within the data sink and the long-term archiving solution is kept within the same VPC in the Cloud and can only be accessed by authorized parties.
--
++For more information on the conceptual ideas behind data management within the eMagiz platform, you can look at this [fundamental](fundamental-traceability-in-emagiz.md). For more concrete information on how to implement it within an eMagiz flow you could check out this [microlearning](../microlearning/advanced-data-management-data-sink.md) and this [microlearning](../microlearning/advanced-data-management-long-term-archiving.md). All the information within the data sink and the long-term archiving solution is kept within the same VPC in the Cloud and can only be accessed by authorized parties.
++
  === 3.9 Compliancy ===
--* eMagiz is currentlty ISO-27001 certified.
--* eMagiz is currently SOC2 Type 2 certified.
++* eMagiz has the ISO-27001 certification at this moment.
  === 3.10 Other ===
@@ -318,31 +318,17 @@
  During these tests, the pentester will try to achieve goals (penetration of the target system on various levels) by undertaking various means. Such a test can help determine whether a system is vulnerable to attack if the defenses were sufficient and which defenses (if any) the test defeated. In addition, eventual findings from those tests are dealt with conforming to the corrective action processes in our ISMS.
++===== Practice =====
++
  == 4. Key takeaways ==
  * Protecting your data is a joint responsibility between eMagiz and you
  * The repository is read-only for clients
  * Data in the Cloud is kept within your VPC
--* The portal is behind an MFA check
--
--== 5. Suggested additional readings ==
++* Production data in the portal is behind an MFA check
--* [[Fundamental (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
--** [[eMagiz Cloud (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-cloud-inner-workings||target="blank"]]
--** [[Traceability (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-traceability-in-emagiz||target="blank"]]
--* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
--** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
--*** [[Security - Add MFA (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-security-add-mfa.WebHome||target="blank"]]
--*** [[Portal Security - Basic (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-manage-portal-security-basic||target="blank"]]
--** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
--** [[Configure Roles and Users (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-roles-and-users||target="blank"]]
--** [[Crash Course Event Streaming (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.WebHome||target="blank"]]
--** [[User Management (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-user-management||target="blank"]]
--* [[Novice Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Novice.WebHome||target="blank"]]
--** [[eMagiz Cloud Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.eMagiz Cloud Management.WebHome||target="blank"]]
--*** [[Cloud Templates Explained (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Novice.eMagiz Cloud Management.novice-emagiz-cloud-management-cloud-templates-explained||target="blank"]]
--* [[Advanced Level (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
--** [[Data Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.WebHome||target="blank"]]
--*** [[Data Sink (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-data-sink||target="blank"]]
--*** [[Long Term Archiving (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Data Management.advanced-data-management-long-term-archiving||target="blank"]]
--)))((({{toc/}}))){{/container}}{{/container}}
++</div>
++</div>
++</div>
++
++{{/html}}

fundamental-emagiz-cloud-inner-workings--customer-level-overview-double-lane.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+65.2 KB

Content

fundamental-emagiz-security-guide--access-rights.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+9.1 KB

Content

fundamental-emagiz-security-guide--api-gateway-portal-feedback.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+14.7 KB

Content

fundamental-emagiz-security-guide--create-new-version.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+23.6 KB

Content

fundamental-emagiz-security-guide--data-orchestration.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+160.8 KB

Content

fundamental-emagiz-security-guide--definition-emagiz-model.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+63.3 KB

Content

fundamental-emagiz-security-guide--history-pages.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.marijn

Size

...	...	@@ -1,0 +1,1 @@
	1	+22.5 KB

Content