Skip to content

Update cloud-soar-bridge.md - Amend SIEM_URL setting #4359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Update cloud-soar-bridge.md - Amend SIEM_URL setting #4359

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6ad195
Update cloud-soar-bridge.md - Ammend SIEM_URL setting
mvirga-sumo Jul 26, 2024
b174fc0
Updates from review
jpipkin1 Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 67 additions & 67 deletions docs/cloud-soar/cloud-soar-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_label: Automation Bridge
description: Learn how to install a bridge for Cloud SOAR to allow running custom actions or integrations in an on-premise environment.
---


import useBaseUrl from '@docusaurus/useBaseUrl';

You can only run custom actions or integrations outside of the Sumo Logic cloud in an "on-premise" environment. For on-premise environments, you need to install a bridge as described below.
Expand All @@ -23,17 +24,21 @@ You can only run custom actions or integrations outside of the Sumo Logic cloud
* Network card: 1

### Network requirements
<!-- These network requirements differ from those for the Automation Service bridge -->

The Bridge must be able to resolve DNS hostnames and reach the below destinations.
The Bridge has to be able to resolve DNS host names and needs to reach the below destinations:

| DESTINATION | PROTOCOL | PORT |
| :-- | :-- | :-- |
| soar-cloud-url | TCP | 443 |
| siem-cloud-url | TCP| 443|
| 784093250948.dkr.ecr.eu-central-1.amazonaws.com | TCP| 443|
| 784093250948.dkr.ecr.us-east-1.amazonaws.com | TCP| 443|
| 784093250948.dkr.ecr.us-west-2.amazonaws.com | TCP| 443|
| sumo-logic-api-url | TCP| 443|
| siem-cloud-url | TCP| 443|
| 926226587429.dkr.ecr.us-west-2.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.us-east-1.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.ap-southeast-2.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.eu-central-1.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.ap-south-1.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.ap-northeast-1.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.ca-central-1.amazonaws.com | TCP| 443|
| 926226587429.dkr.ecr.eu-west-1.amazonaws.com | TCP| 443|
| index.docker.io* | TCP| 443|
| registry-1.docker.io* | TCP| 443|
| auth.docker.io* | TCP| 443|
Expand All @@ -46,25 +51,24 @@ The Bridge must be able to resolve DNS hostnames and reach the below destination

1. Install Docker-CE following the [installation instructions in Docker Docs](https://docs.docker.com/engine/install/). Install at least version 20.10 (do not use nightly build).
1. As soon as the Docker daemon is installed, start it with:
```sh
```
systemctl start docker
```
1. Enable it on boot:
```sh
```
systemctl enable docker
```

### Using a proxy

### Using a proxy
1. If Docker has to use a proxy to pull images, follow the below instructions:
```sh
mkdir -p /etc/systemd/system/docker.service.d
```
1. Create a file named `/etc/systemd/system/docker.service.d/http-proxy.conf`, and add:
```sh
```
[Service]
Environment="HTTP_PROXY=http://proxy.example.com:8080\"
Environment="HTTPS_PROXY=http://proxy.example.com:8080\"
Environment="HTTP_PROXY=http://proxy.example.com:8080"
Environment="HTTPS_PROXY=http://proxy.example.com:8080"
```
1. Reload the systemd daemon with:
```sh
Expand All @@ -77,36 +81,29 @@ The Bridge must be able to resolve DNS hostnames and reach the below destination

## Get installation token

Log in to Sumo Logic and create a new [installation token](/docs/manage/security/installation-tokens/) with the name prefix `csoar-bridge-token`.
Log in to Sumo Logic and create a new [installation token](/docs/manage/security/installation-tokens/) with name prefix `csoar-bridge-token`.

<img src={useBaseUrl('img/cse/automations-bridge-installation-token.png')} alt="Installation token" width="800"/>
<img src={useBaseUrl('img/cse/automations-bridge-installation-token.png')} alt="Installation token" style={{border:'1px solid gray'}} width="800"/>

## Automation installation
## Automation bridge installation

### Ubuntu
<!--Kanso
Kanso-->
1. <!--Kanso [**Classic UI**](/docs/cloud-soar/overview#classic-ui). Kanso--> Click the **?** icon in the top right. <!--Kanso <br/>[**New UI**](/docs/cloud-soar/overview#new-ui). In the main Sumo Logic menu, select **Automation > Bridge**. You can also click the **Go To...** menu at the top of the screen and select **Bridge**. Kanso--> <!-- There is no option to install a bridge in the new UI. -->
1. Click the **UBUNTU** button.

1. <!--Kanso [**Classic UI**](/docs/cloud-soar/overview#classic-ui). Kanso--> Click the **?** icon in the top right. <!--Kanso <br/>[**New UI**](/docs/get-started/sumo-logic-ui-new/). In the main Sumo Logic menu, select **Automation > Bridge**. You can also click the **Go To...** menu at the top of the screen and select **Bridge**. Kanso--> <!-- There is no option to install a bridge in the new UI. -->
1. In the **Automation Bridge Manual** box, click **UBUNTU**.
1. Click **Download** to download the `automation-bridge-X.X.deb` file.
1. Copy the file to the bridge virtual machine. You can use SCP - see example below:
```sh
scp -r -i /path/to/private_key /path/to/local/folder remote_user@remote_ip:/path/to/remote/folder
```
3. To install the package run from ssh:
1. Copy the file to the bridge virtual machine.
1. To install the package run from ssh:
```sh
sudo dpkg -i automation-bridge-X.X.deb
```

### CentOS/RedHat

1. <!--Kanso [**Classic UI**](/docs/cloud-soar/overview#classic-ui). Kanso--> Click the **?** icon in the top right. <!--Kanso <br/>[**New UI**](/docs/cloud-soar/overview#new-ui). In the main Sumo Logic menu, select **Automation > Bridge**. You can also click the **Go To...** menu at the top of the screen and select **Bridge**. Kanso--> <!-- There is no option to install a bridge in the new UI. -->
1. In the **Automation Bridge** box, click **CENTOS/REDHAT**.
1. <!--Kanso [**Classic UI**](/docs/cloud-soar/overview#classic-ui). Kanso--> Click the **?** icon in the top right. <!--Kanso <br/>[**New UI**](/docs/get-started/sumo-logic-ui-new/). In the main Sumo Logic menu, select **Automation > Bridge**. You can also click the **Go To...** menu at the top of the screen and select **Bridge**. Kanso--> <!-- There is no option to install a bridge in the new UI. -->
1. In the **Automation Bridge Manual** box, click **CENTOS/REDHAT**.
1. Click **Download** to download the `automation-bridge-X.X.rpm` file.
1. Copy the file to the bridge virtual machine (You can use SCP, see example below).
```sh
scp -r -i /path/to/private_key /path/to/local/folder remote_user@remote_ip:/path/to/remote/folder
```
1. Copy the file to the bridge virtual machine.
1. To install the package run from ssh:
```sh
sudo yum install automation-bridge-X.X.rpm
Expand All @@ -127,44 +124,47 @@ An example of a configuration file would be:
{
"SOAR_URL":"API_ENDPOINT_FROM_FIREWALL_DOC_FOR_YOUR_REGION",
"SOAR_TOKEN":"TOKEN_FROM_ADMINISTRATION_-->_SECURITY_-->_INSTALLATION TOKEN",
"SIEM_URL":"https://YOUR_CSE_URL/sec",
"SIEM_URL":"The HTTPS Source Endpoint URL From a Hosted Sumo Logic Collector",
"ALIAS":"YOUR_ALIAS_NO_SPACES_LESS_THAN_20_CHARACTERS"
}
```
To create a Hosted Sumo Logic Collector, see [Hosted Collectors](/docs/send-data/hosted-collectors/). To add an HTTPS Source to a Hosted Collector, see [HTTP Logs and Metrics Source](/docs/send-data/hosted-collectors/http-source/logs-metrics/).

By adding this endpoint to `SIEM_URL`, this will enable the automation-bridge logs to be forwarded to Sumo Logic Log Analytics.

### Bridge ALIAS

With bridge ALIAS, it is possible to distinguish which integration resources will be executed with this automation bridge. When a new integration resource is created or edited, it is possible to select the default ALIAS or to create a new one. So every automatic action configured to use this resource will be performed with the Bridge that has the same ALIAS.
With bridge ALIAS, it is possible to distinguish which integration resources will be executed with this automation bridge. When a new integration resource is created or edited it is possible to select the default ALIAS or to create a new one. So every automatic action configured to use this resource will be performed with the Bridge that has the same ALIAS.

<img src={useBaseUrl('img/cloud-soar/automations-bridge-alias-create.png')} alt="Create ALIAS bridge" width="400"/>
<img src={useBaseUrl('img/cse/automations-bridge-alias-create.png')} style={{border:'1px solid gray'}} alt="Create ALIAS bridge" width="400"/>

<img src={useBaseUrl('img/cloud-soar/automations-bridge-alias-default.png')} alt="Use default ALIAS bridge" width="400"/>
<img src={useBaseUrl('img/cse/automations-bridge-alias-default.png')} style={{border:'1px solid gray'}} alt="Use default ALIAS bridge" width="400"/>

### Automation bridge update

For Ubuntu and CentOS/RedHat, the update process works as the installation process. Follow the same steps described in [Automation bridge installation](#automation-installation) above.
For Ubuntu and CentOS/RedHat, the update process works as the installation process. Follow the same steps described in [Automation bridge installation](#automation-bridge-installation) above.

:::note
If you are not using the SIEM:
1. Set `SIEM_URL` to `NONE`.
1. Restart the service with:
```sh
```
systemctl restart automation-bridge
```
1. If you need to allow automation-bridge communication through a proxy, edit the file `/etc/opt/automation-bridge/automation-bridge.conf` and set the correct value. Below is an example:
```sh
HTTP_PROXY="http://proxy.example.com:8080"
HTTPS_PROXY="http://proxy.example.com:8080"
```
HTTP_PROXY="http://proxy.example.com:8080\"
HTTPS_PROXY="http://proxy.example.com:8080\"
```
1. Restart the service with:
```sh
```
systemctl restart automation-bridge
```
:::

### Configuring the automation bridge for high availability

You may elect to deploy and register multiple bridges to your Cloud SOAR tenant for high availability. To cluster automation bridges together logically within Cloud SOAR and ensure high availability, you must set the same ALIAS for each bridge within the cluster in each respective `user-configuration.conf` file upon installation.
You may elect to deploy and register multiple bridges to your tenant for high availability. To cluster automation bridges together logically within the Automation Service and ensure high availability, you must set the same ALIAS for each bridge within the cluster in each respective `user-configuration.conf` file upon installation.

When multiple bridges are registered with the same ALIAS, they will appear as active. If one or more bridges within the cluster go offline, playbooks will execute via the active nodes utilizing the same ALIAS. So long as there is parity between the nodes and there is at least one active node registered, there will be no disruption in playbook execution.

Expand All @@ -177,11 +177,11 @@ To check if the bridge is running correctly, run the following command:
ps faux |grep automation-bridge
```

This is an example of running `automation-bridge`:<br/><img src={useBaseUrl('img/cloud-soar/automations-bridge-example-output.png')} alt="Example of running automation-bridge" width="800"/>
This is an example of running `automation-bridge`:<br/><img src={useBaseUrl('img/cse/automations-bridge-example-output.png')} style={{border:'1px solid gray'}} alt="Example of running automation-bridge" width="800"/>

On the **Bridge** tab in the [Automation Service UI](/docs/platform-services/automation-service/about-automation-service/#automation-service-ui), a list of live bridge agents will be displayed along with their status.

On the SOAR instance, a list of live bridge agents will be displayed along with their status:
1. <!--Kanso [**Classic UI**](/docs/cloud-soar/overview#classic-ui). Kanso--> Click the gear icon <img src={useBaseUrl('img/cloud-soar/cloud-soar-settings-icon.png')} alt="Settings menu icon" style={{border: '1px solid gray'}} width="25"/> in the top right, select **Automation**, and then select **Bridge** in the left nav bar. <!--Kanso <br/>[**New UI**](/docs/cloud-soar/overview#new-ui). In the main Sumo Logic menu, select **Automation > Bridge**. You can also click the **Go To...** menu at the top of the screen and select **Bridge**. Kanso-->
1. Verify that the bridge is installed and operational.
<img src={useBaseUrl('img/platform-services/bridge-main-screen.png')} style={{border:'1px solid gray'}} alt="Bridge screen" width="800"/>

### Configuring the automation bridge for CyberArk

Expand All @@ -195,13 +195,13 @@ If you are using CyberArk, you must add the following certificates provided by C
#### Enable Podman socket

1. Run the following commands:
```bash
systemctl enable podman.socket && systemctl start podman.socket
```
```bash
systemctl enable podman.socket && systemctl start podman.socket
```
1. Create a symbolic link:
```bash
ln -s /run/podman/podman.sock /var/run/docker.sock
```
```bash
ln -s /run/podman/podman.sock /var/run/docker.sock
```

#### Change automation bridge configuration

Expand All @@ -219,7 +219,7 @@ ExecStop=/bin/kill -s TERM $MAINPID
Restart=on-failure
TimeoutStartSec=10
RestartSec=10

##
NoNewPrivileges=yes
PrivateTmp=yes
PrivateDevices=yes
Expand All @@ -232,25 +232,25 @@ WantedBy=multi-user.target
This is the current solution and it needs to run service as `root`.
:::

## Cloud SOAR automation bridge for Docker
## Automation bridge for Docker

This repository provides Docker images to run the Sumo Logic Cloud SOAR automation bridge. The images contain an automation bridge able to connect to the Sumo Logic SOAR environment.
This repository provides Docker images to run the Sumo Logic automation bridge. The images contain an automation bridge able to connect to the Automation Service environment.

### Use the Docker automation bridge image

There are images tagged `latest` and for specific versions to run the automation bridge.

When run, the automation bridge listens on the Docker Unix socket to be able to execute the Cloud SOAR integration or run a standalone daemon.
When run, the automation bridge listens on the Docker Unix socket to be able to execute the integration or to run a standalone daemon.

The Cloud SOAR automation bridge needs to be able to communicate with the Docker API to work.
The automation bridge needs to be able to communicate with the Docker API to work.

### Prerequisites and configuration

|Environment Variable |Description |Default |
|:--|:--|:--|
|`API_URL_HERE` |To determine which is the correct SOAR_URL, see [Sumo Logic Endpoints by Deployment and Firewall Security](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security) and get the URL under the API Endpoint column. For example: `https://api.eu.sumologic.com/api/` | |
|`SOAR_TOKEN_HERE`|Log in to Sumo Logic and create a new [installation token](/docs/manage/security/installation-tokens/) with the name prefix `csoar-bridge-token`. | |
|`SIEM_URL_HERE` | The HTTP Sumo Logic collector to send the bridge logs. | NONE |
|Environment Variable |Description |Default |
|:------------------------------------|:---------------|:----------|
|`API_URL_HERE` | To determine which is the correct SOAR_URL, see [Sumo Logic Endpoints by Deployment and Firewall Security](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security) and get the URL under the API Endpoint column. For example: `https://api.eu.sumologic.com/api/` | |
|`SOAR_TOKEN_HERE` | Log in to Sumo Logic and create a new [installation token](/docs/manage/security/installation-tokens/) with the name prefix `csoar-bridge-token`. | |
|`SIEM_URL_HERE` | The HTTPS Source endpoint URL from a hosted Sumo Logic Collector. | NONE |
|`BRIDGE_ALIAS_HERE` | Provide the alias name. With bridge ALIAS, it is possible to distinguish which integration resources will be executed with this automation bridge. When a new integration resource is created or edited, it is possible to select the default ALIAS or to create a new one. So every automatic action configured to use this resource will be performed with the bridge that has the same ALIAS. | NONE |

### Methodologies
Expand All @@ -275,15 +275,15 @@ public.ecr.aws/u5z5f8z6/sumologic/csoar-automation-bridge:latest

In the DooD approach, you use the Docker daemon from the host system to interact with containers. Containers themselves do not have their own Docker runtime; they communicate with the host's Docker. This offers some distinct advantages, including simplicity in managing the containers and resource efficiency, as containers do not need to run their own Docker daemon.

This way, the main container will have access to the Docker socket and can start containers. The only difference is that instead of starting “child” containers, it will start “sibling” containers.
This way, the main container will have access to the Docker socket and will, therefore, be able to start containers. The only difference is that instead of starting “child” containers, it will start “sibling” containers.

![Mounting Docker socket](https://cdn.hashnode.com/res/hashnode/image/upload/v1693178230450/3b5e8d84-a6e6-40b9-acce-8b2f623e67be.png?auto=compress,format&format=webp)

It's useful to share pulled images with all bridges running on the host machine.
It's useful to share the pulled image with all bridges running on the host machine.

#### With privileged option

```bash
```bash
docker run -d \
--privileged \
-e SOAR_URL=API_URL_HERE \
Expand All @@ -293,7 +293,7 @@ docker run -d \
-e DOCKER_TLS_CERTDIR=/certs \
-v docker-certs-ca:/certs/ca -v docker-certs-client:/certs/client \
public.ecr.aws/u5z5f8z6/sumologic/csoar-automation-bridge:latest
```
```

Privileged containers are special containers with elevated privileges and direct access to the host system. Unlike their non-privileged counterparts, which are isolated and restricted in their capabilities, privileged containers can perform tasks requiring higher-level access. They achieve this by interacting with the host kernel and accessing sensitive resources, including hardware devices and network interfaces.

Expand Down