Skip to content

Commit

Permalink
Merge branch 'main' into feature/add-usecase-description
Browse files Browse the repository at this point in the history
  • Loading branch information
kojofl authored Nov 2, 2023
2 parents 91659cf + b401d48 commit 7bbbbd9
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
28 changes: 14 additions & 14 deletions _includes/scenarios/integrate/data-model-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,11 +346,11 @@ The properties of the `AcceptResponseItem` are:

The properties of the `RejectResponseItem` are:

| Name | Type | Description |
| -------- | ----------------------- | ------------------------------------------------------------- |
| result | `"Rejected"` | The only possible value here is the string `"Rejected"`. |
| code? | `string` \| `undefined` | A code telling the sender about the reason for the rejection. |
| message? | `string` \| `undefined` | A human readable message with details about the rejection. |
| Name | Type | Description |
| ------- | ----------------------- | ------------------------------------------------------------- |
| result | `"Rejected"` | The only possible value here is the string `"Rejected"`. |
| code | `string` \| `undefined` | A code telling the sender about the reason for the rejection. |
| message | `string` \| `undefined` | A human readable message with details about the rejection. |

#### ErrorResponseItem

Expand Down Expand Up @@ -450,15 +450,15 @@ There are cases in which you want to query some data from your peer that is not

#### ValueHints

| Name | Type | Description |
| -------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| editHelp? | `string` | A help text you can use to describe the purpose of the Attribute. |
| min? | `number` | In case of a string: the minimum length of the string. In case of an integer: the minimum value. |
| max? | `number` | In case of a string: the maximum length of the string. In case of an integer: the maximum value. |
| pattern? | `string` | A [regular expression](https://en.wikipedia.org/wiki/Regular_expression) that is used to validate the value. Only applicable if the value is a string. |
| values? | [`ValueHintsValue`](#valuehintsvalue)`[]` | An array of allowed values. |
| defaultValue? | `string` \| `number` \| `boolean` | The default value that is used if no value is provided. |
| propertyHints? | `Record<string,` [`ValueHints>`](#valuehints) | A set of Value Hints of all properties. The key is the name of the property and the value a `ValueHints` object. Only applicable if the value is complex. |
| Name | Type | Description |
| ------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| editHelp | `string` \| `undefined` | A help text you can use to describe the purpose of the Attribute. |
| min | `number` \| `undefined` | In case of a string: the minimum length of the string. In case of an integer: the minimum value. |
| max | `number` \| `undefined` | In case of a string: the maximum length of the string. In case of an integer: the maximum value. |
| pattern | `string` \| `undefined` | A [regular expression](https://en.wikipedia.org/wiki/Regular_expression) that is used to validate the value. Only applicable if the value is a string. |
| values | [`ValueHintsValue`](#valuehintsvalue)`[]` \| `undefined` | An array of allowed values. |
| defaultValue | `string` \| `number` \| `boolean` \| `undefined` | The default value that is used if no value is provided. |
| propertyHints | `Record<string,` [`ValueHints>`](#valuehints) \| `undefined` | A set of Value Hints of all properties. The key is the name of the property and the value a `ValueHints` object. Only applicable if the value is complex. |

#### ValueHintsOverride

Expand Down
4 changes: 2 additions & 2 deletions _includes/scenarios/integrate/requests-over-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ For more information about the events you can head over to the [Connector Module

### Accept

If you want to accept the Request you can do so by calling the `POST /api/v2/Requests/Incoming/{id}/Accept` route. You can use the `id` you saved in the previous step. In the payload you have to accept at least all RequestItems where the `mustBeAccepted` property is set to `true`. In case of the example Request the payload is the following:
If you want to accept the Request you can do so by calling the `PUT /api/v2/Requests/Incoming/{id}/Accept` route. You can use the `id` you saved in the previous step. In the payload you have to accept at least all RequestItems where the `mustBeAccepted` property is set to `true`. In case of the example Request the payload is the following:

```jsonc
{
Expand All @@ -129,7 +129,7 @@ If you want to accept the Request you can do so by calling the `POST /api/v2/Req

### Reject

If you want to reject the Request you can do so by calling the `POST /api/v2/Requests/Incoming/{id}/Reject` route. You can use the `id` you saved in the previous step. In the payload you have to reject all RequestItems. In case of the example Request the payload is the following:
If you want to reject the Request you can do so by calling the `PUT /api/v2/Requests/Incoming/{id}/Reject` route. You can use the `id` you saved in the previous step. In the payload you have to reject all RequestItems. In case of the example Request the payload is the following:

```jsonc
{
Expand Down
6 changes: 3 additions & 3 deletions _includes/scenarios/integrate/requests-over-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can use the [Connector Installation Guide]({% link _docs_operate/setup-with-

{% include properties_list.html %}

On the first Connector you will create a Template. This Connector will be called Templator in the in the following steps. The second Connector is called Requestor, because it will create the Relationship and therefore it creates the `RelationshipCreationChangeRequest`.
On the first Connector you will create a Template. This Connector will be called Templator in the following steps. The second Connector is called Requestor, because it will create the Relationship and therefore it creates the `RelationshipCreationChangeRequest`.

## Check your Request's validity

Expand Down Expand Up @@ -90,7 +90,7 @@ If there is no open RelationshipRequest or existing Relationship, you can trigge

### Reject

If you want to reject the Request you can do so by calling the `POST /api/v2/Requests/Incoming/{id}/Reject` route. You can use the `id` you saved in the previous step. In the payload you have to reject all RequestItems. In case of the example Request the payload is the following:
If you want to reject the Request you can do so by calling the `PUT /api/v2/Requests/Incoming/{id}/Reject` route. You can use the `id` you saved in the previous step. In the payload you have to reject all RequestItems. In case of the example Request the payload is the following:

```jsonc
{
Expand All @@ -108,7 +108,7 @@ In the response you can see the Request has moved to status `Decided`. This is w

If you tried out the Rejection before this step make sure to create a Request by [loading the Template again](#load-the-template-and-get-the-request) with the same truncated reference.

If you want to accept the Request you can do so by calling the `POST /api/v2/Requests/Incoming/{id}/Accept` route. You can use the `id` you saved in the [template loading](#load-the-template-and-get-the-request) step. In the payload you have to accept at least all RequestItems where the `mustBeAccepted` property is set to `true`. In case of the example Request the payload is the following:
If you want to accept the Request you can do so by calling the `PUT /api/v2/Requests/Incoming/{id}/Accept` route. You can use the `id` you saved in the [template loading](#load-the-template-and-get-the-request) step. In the payload you have to accept at least all RequestItems where the `mustBeAccepted` property is set to `true`. In case of the example Request the payload is the following:

```jsonc
{
Expand Down
4 changes: 2 additions & 2 deletions _includes/scenarios/operate/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,11 @@ The debug flag configures if the Connector is set to **production** or **debug**

- **platformClientId** `required`

The client id is required to communicate with the enmeshed platform. It can be acquired from the [enmeshed Support]({% link _docs_operate/setup-with-docker-compose.md %}#support).
The client id is required to communicate with the enmeshed platform. It can be acquired from the [enmeshed Support]({% link _docs_operate/support.md %}).

- **platformClientSecret** `required`

The client secret is required to communicate with the enmeshed platform. It can be acquired from the [enmeshed Support]({% link _docs_operate/setup-with-docker-compose.md %}#support).
The client secret is required to communicate with the enmeshed platform. It can be acquired from the [enmeshed Support]({% link _docs_operate/support.md %}).

### database

Expand Down
6 changes: 3 additions & 3 deletions _includes/scenarios/operate/security-considerations.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Thus please consider scanning the host systems and the database for viruses regu

## Networking

It is best practice to block unnecessary access from and to software components between networks. In this chapter it is described which access the Connector actually required and which requests could be blocked.
It is best practice to block unnecessary access from and to software components between networks. In this chapter it is described which access the Connector actually requires and which requests could be blocked.

### Outbound External Connection: Internet

Expand Down Expand Up @@ -66,7 +66,7 @@ End user authentication, e.g. business users accessing the system, should be don

Kernel dumps can be a useful tool for diagnosing and troubleshooting system issues. However, they can also be a security risk if they contain sensitive information such as encryption keys. If an attacker gains access to a kernel dump file, they may be able to extract this information and use it to compromise the security of your system.

As the Connector does not have access to the host system, it cannot directly control whether or not kernel dumps are enabled. Therefore, the administrator of the host system make a decision on whether or not to disable kernel dumps based on their own security policies and risk tolerance.
As the Connector does not have access to the host system, it cannot directly control whether or not kernel dumps are enabled. Therefore, the administrator of the host system makes a decision on whether or not to disable kernel dumps based on their own security policies and risk tolerance.

The recommended course of action is to disable kernel dumps on the host system, outside a development environment, where the Connector is running. This is in line with the [recommendation of libsodium](https://libsodium.gitbook.io/doc/memory_management#locking-memory), the used encryption library.

Expand All @@ -78,7 +78,7 @@ It is important to ensure that API keys are secure and cannot be easily compromi

## Docker Compose File Security Considerations

Docker Compose is a tool to easily set up and host and complete landscape by running multiple Docker containers, configure them and link them together with a network. For development, testing and demonstration purposes, the enmeshed team provides Docker Compose files throughout this site or on GitHub. Please be aware, that those Docker Compose files should not be used in a public or productive environment, as they could contain insecure or otherwise unstable configurations, e.g. default passwords or the missing encryption at rest for MongoDB configuration. If you choose to use Docker Compose files in a public or production environment, it is important to educate yourself on how to create production-grade Docker Compose files to ensure the security of your system.
Docker Compose is a tool to easily set up and host a complete landscape by running multiple Docker containers, configuring them and linking them together with a network. For development, testing and demonstration purposes, the enmeshed team provides Docker Compose files throughout this site or on GitHub. Please be aware, that those Docker Compose files should not be used in a public or productive environment, as they could contain insecure or otherwise unstable configurations, e.g. default passwords or the missing encryption at rest for MongoDB configuration. If you choose to use Docker Compose files in a public or production environment, it is important to educate yourself on how to create production-grade Docker Compose files to ensure the security of your system.

## Setup Firewall

Expand Down

0 comments on commit 7bbbbd9

Please sign in to comment.