Skip to content

Commit fbe051d

Browse files
CRWDFalcon update
1 parent 9dea72d commit fbe051d

2 files changed

Lines changed: 116 additions & 113 deletions

File tree

Lines changed: 85 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
---
22
title: Ingest CrowdStrike Falcon Detections and Incidents into TheHive Using an External Script
33
description: Install and configure the falcon2thehive connector to automatically ingest CrowdStrike Falcon detections and incidents into TheHive as alerts in real time.
4-
tags:
4+
tags:
55
- alert-ingestion
66
- crowdstrike
77
- thehive
88
- automation
99
---
1010
# Tutorial: Ingest CrowdStrike Falcon Detections and Incidents into TheHive Using an External Script
1111

12-
<!-- md:integration External --> <!-- md:version 5.0 -->
12+
> **Warning:** The falcon2thehive connector is currently in beta. Features and configuration may change.
1313
14-
{% include-markdown "includes/falcon2thehive-beta.md" %}
14+
In this tutorial, we're going to install and configure the [falcon2thehive connector](https://github.com/StrangeBeeCorp/falcon2thehive) to ingest CrowdStrike Falcon detections and incidents into TheHive as alerts.
1515

16-
In this tutorial, we're going to install and configure the [falcon2thehive connector](https://github.com/StrangeBeeCorp/falcon2thehive){target=_blank} to ingest CrowdStrike Falcon detections and incidents into TheHive as alerts.
17-
18-
By the end, you’ll have a working setup that automatically brings CrowdStrike Falcon detections and incidents into TheHive in real time, helping your team respond as soon as they happen.
16+
By the end, you'll have a working setup that automatically brings CrowdStrike Falcon detections and incidents into TheHive in real time, helping your team respond as soon as they happen.
1917

2018
Before you begin, ensure that the CrowdStrike Falcon detections and incidents you want to ingest are part of the supported event types:
2119

@@ -25,14 +23,14 @@ Before you begin, ensure that the CrowdStrike Falcon detections and incidents yo
2523
* IdpDetectionSummaryEvent
2624
* MobileDetectionSummaryEvent
2725

28-
!!! tip "More integration options"
29-
For the complete list of integration options between CrowdStrike Falcon and TheHive, see [CrowdStrike Falcon Integration with TheHive](crowdstrike-falcon-integrations.md).
26+
> **Tip:** More integration options
27+
> For the complete list of integration options between CrowdStrike Falcon and TheHive, see [CrowdStrike Falcon Integration with TheHive](crowdstrike-falcon-integrations.md).
3028
3129
## Step 1: Create an API client in CrowdStrike Falcon
3230

33-
Lets start by setting up an API client in your CrowdStrike Falcon console. This will allow the connector to securely access your detections and incidents.
31+
Let's start by setting up an API client in your CrowdStrike Falcon console. This will allow the connector to securely access your detections and incidents.
3432

35-
1. Go to [https://www.crowdstrike.com/login/](https://www.crowdstrike.com/login/){target=_blank}.
33+
1. Go to [https://www.crowdstrike.com/login/](https://www.crowdstrike.com/login/).
3634

3735
2. Log in to your CrowdStrike Falcon tenant with an administrator account.
3836

@@ -46,33 +44,31 @@ Let’s start by setting up an API client in your CrowdStrike Falcon console. Th
4644

4745
7. Select **Create**.
4846

49-
8. Youll now see your client ID, secret, and base URL. Copy and save them somewhere safe. Youll need them in the next step.
47+
8. You'll now see your client ID, secret, and base URL. Copy and save them somewhere safe. You'll need them in the next step.
5048

5149
## Step 2: Install and configure falcon2thehive
5250

5351
You can install the falcon2thehive connector using either a [Docker deployment](#docker-deployment) or a [manual installation](#manual-python-installation), depending on your setup and preferences. Docker is the recommended method for ease of deployment and consistency.
5452

5553
### Docker deployment
5654

57-
!!! note "Recommended installation method"
58-
Installing the falcon2thehive connector with Docker is the easiest and most reliable option. It helps keep your environment clean and makes deployment straightforward.
59-
60-
!!! warning "Requirements"
61-
Before you begin, make sure [Docker](https://docs.docker.com/get-started/get-docker/){target=_blank} is installed on your system.
55+
> **Note:** Installing the falcon2thehive connector with Docker is the easiest and most reliable option. It helps keep your environment clean and makes deployment straightforward.
6256
63-
!!! tip "Quick testing"
64-
If you just want to test the falcon2thehive connector, you can pass credentials directly as environment variables instead of using a `.env` file.
57+
> **Warning:** Before you begin, make sure [Docker](https://docs.docker.com/get-started/get-docker/) is installed on your system.
6558
66-
```bash
67-
docker run -d \
68-
--restart unless-stopped \
69-
-e CRWD_BASE_URL="<crowdstrike_base_url>" \
70-
-e CRWD_CLIENT_ID="<crowdstrike_client_id>" \
71-
-e CRWD_CLIENT_SECRET="<crowdstrike_client_secret>" \
72-
-e THEHIVE_URL="<thehive_url>" \
73-
-e THEHIVE_API_KEY="<thehive_api_key>" \
74-
--name f2h falcon2thehive
75-
```
59+
> **Tip:** Quick testing
60+
> If you just want to test the falcon2thehive connector, you can pass credentials directly as environment variables instead of using a `.env` file.
61+
>
62+
> ```bash
63+
> docker run -d \
64+
> --restart unless-stopped \
65+
> -e CRWD_BASE_URL="<crowdstrike_base_url>" \
66+
> -e CRWD_CLIENT_ID="<crowdstrike_client_id>" \
67+
> -e CRWD_CLIENT_SECRET="<crowdstrike_client_secret>" \
68+
> -e THEHIVE_URL="<thehive_url>" \
69+
> -e THEHIVE_API_KEY="<thehive_api_key>" \
70+
> --name f2h falcon2thehive
71+
> ```
7672
7773
1. Build the Docker image.
7874
@@ -101,7 +97,17 @@ You can install the falcon2thehive connector using either a [Docker deployment](
10197
APP_ID=falcon2thehive
10298
```
10399
104-
{% include-markdown "includes/falcon2thehive-environment-variables-explained.md" %}
100+
**Environment variables explained:**
101+
102+
| Variable | Required | Description |
103+
|---|---|---|
104+
| `CRWD_BASE_URL` | Yes | Your CrowdStrike Falcon base URL |
105+
| `CRWD_CLIENT_ID` | Yes | API client ID from Step 1 |
106+
| `CRWD_CLIENT_SECRET` | Yes | API client secret from Step 1 |
107+
| `THEHIVE_URL` | Yes | URL of your TheHive instance |
108+
| `THEHIVE_API_KEY` | Yes | API key for TheHive authentication |
109+
| `THEHIVE_ORG` | No | Target organization in TheHive |
110+
| `APP_ID` | No | Application ID for the CrowdStrike streaming API (default: `falcon2thehive`) |
105111
106112
c. Run the container.
107113
@@ -114,49 +120,43 @@ You can install the falcon2thehive connector using either a [Docker deployment](
114120
115121
At this point, the connector should be live and syncing CrowdStrike Falcon detections and incidents with TheHive.
116122
117-
!!! tip "Connector operation commands"
118-
119-
Here are some useful commands for managing the connector:
120-
121-
* View logs:
122-
```bash
123-
docker logs -f f2h
124-
```
125-
126-
* Stop the connector:
127-
```bash
128-
docker stop f2h
129-
```
130-
131-
* Restart the connector with the same configuration:
132-
```bash
133-
docker start f2h
134-
```
135-
136-
* To change environment variables:
137-
138-
139-
a. Stop and remove the container:
140-
141-
```bash
142-
docker stop f2h
143-
docker rm f2h
144-
```
145-
146-
b. Start a new one with updated environment variables using `-e` flags or an updated `.env` file:
147-
148-
```bash
149-
docker run -d --restart unless-stopped --env-file .env --name f2h falcon2thehive
150-
```
123+
> **Tip:** Connector operation commands
124+
>
125+
> * View logs:
126+
> ```bash
127+
> docker logs -f f2h
128+
> ```
129+
>
130+
> * Stop the connector:
131+
> ```bash
132+
> docker stop f2h
133+
> ```
134+
>
135+
> * Restart the connector with the same configuration:
136+
> ```bash
137+
> docker start f2h
138+
> ```
139+
>
140+
> * To change environment variables:
141+
>
142+
> a. Stop and remove the container:
143+
> ```bash
144+
> docker stop f2h
145+
> docker rm f2h
146+
> ```
147+
>
148+
> b. Start a new one with updated environment variables using `-e` flags or an updated `.env` file:
149+
> ```bash
150+
> docker run -d --restart unless-stopped --env-file .env --name f2h falcon2thehive
151+
> ```
151152
152153
### Manual Python installation
153154
154-
!!! warning "Requirements"
155-
Before you begin, make sure the following tools are installed on your system:
156-
157-
* [Python 3.X](https://www.python.org/downloads/){target=_blank}
158-
* [TheHive4py 2.X](https://github.com/TheHive-Project/TheHive4py){target=_blank}
159-
* [FalconPy SDK](https://github.com/CrowdStrike/falconpy){target=_blank}
155+
> **Warning:** Before you begin, make sure the following tools are installed on your system:
156+
>
157+
> * [Python 3.X](https://www.python.org/downloads/)
158+
> * [TheHive4py 2.X](https://github.com/TheHive-Project/TheHive4py)
159+
> * [FalconPy SDK](https://github.com/CrowdStrike/falconpy)
160160
161161
1. Clone the falcon2thehive repository.
162162
@@ -167,7 +167,7 @@ At this point, the connector should be live and syncing CrowdStrike Falcon detec
167167
168168
2. Recommended: Create and activate a virtual environment.
169169
170-
Using a virtual environment helps isolate dependencies so they dont interfere with other Python projects.
170+
Using a virtual environment helps isolate dependencies so they don't interfere with other Python projects.
171171
172172
```bash
173173
python3 -m venv .venv
@@ -193,13 +193,23 @@ At this point, the connector should be live and syncing CrowdStrike Falcon detec
193193
# Optional settings
194194
export THEHIVE_ORG="<organization_name>"
195195
export APP_ID="falcon2thehive"
196-
```
196+
```
197+
198+
**Environment variables explained:**
197199
198-
{% include-markdown "includes/falcon2thehive-environment-variables-explained.md" %}
200+
| Variable | Required | Description |
201+
|---|---|---|
202+
| `CRWD_BASE_URL` | Yes | Your CrowdStrike Falcon base URL |
203+
| `CRWD_CLIENT_ID` | Yes | API client ID from Step 1 |
204+
| `CRWD_CLIENT_SECRET` | Yes | API client secret from Step 1 |
205+
| `THEHIVE_URL` | Yes | URL of your TheHive instance |
206+
| `THEHIVE_API_KEY` | Yes | API key for TheHive authentication |
207+
| `THEHIVE_ORG` | No | Target organization in TheHive |
208+
| `APP_ID` | No | Application ID for the CrowdStrike streaming API (default: `falcon2thehive`) |
199209
200210
5. Run the connector.
201211
202-
Now its time to start the connector.
212+
Now it's time to start the connector.
203213
204214
* To run it in the background so it stays active while you continue working on other tasks:
205215
@@ -213,8 +223,8 @@ At this point, the connector should be live and syncing CrowdStrike Falcon detec
213223
python falcon2thehive.py
214224
```
215225
216-
You should now start seeing CrowdStrike Falcon detections and incidents in your TheHive alert list. If youre running it in the foreground, you should see log messages confirming a successful connection and alert ingestion.
226+
You should now start seeing CrowdStrike Falcon detections and incidents in your TheHive alert list. If you're running it in the foreground, you should see log messages confirming a successful connection and alert ingestion.
217227
218-
<h2>Next steps</h2>
228+
## Next steps
219229
220230
* [Synchronize Alert and Case Statuses from TheHive to CrowdStrike Falcon](synchronize-status-thehive-crowdstrike-falcon.md)

integrations/vendors/CrowdstrikeFalcon/use-cases/synchronize-status-thehive-crowdstrike-falcon.md

Lines changed: 31 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,47 @@
11
---
22
title: Synchronise status between TheHive alerts/cases and CrowdStrike detections/incidents
33
description: Keep case/alert status in sync between TheHive and CrowdStrike Falcon using notifications and the CrowdStrikeFalcon_Sync responder.
4-
tags:
4+
tags:
55
- status
66
- sync
77
- crowdstrike
88
- thehive
99
- automation
10+
thehive_version_required: "5.0"
11+
license_required: "platinum"
1012
---
1113
# Tutorial: Synchronize Alert and Case Statuses from TheHive to CrowdStrike Falcon
1214

13-
<!-- md:license Platinum -->
15+
In this tutorial, we're going to install and configure the Cortex responder *[Status Sync](https://thehive-project.github.io/Cortex-Analyzers/responders/CrowdstrikeFalcon/#crowdstrikefalcon_sync)*.
1416

15-
In this tutorial, we're going to install and configure the Cortex responder *[Status Sync](https://thehive-project.github.io/Cortex-Analyzers/responders/CrowdstrikeFalcon/#crowdstrikefalcon_sync){target=_blank}*.
17+
By the end, you'll have a setup that automatically keeps alert and case statuses in sync between TheHive and CrowdStrike Falcon, so that your investigations stay aligned across both platforms.
1618

17-
By the end, you’ll have a setup that automatically keeps alert and case statuses in sync between TheHive and CrowdStrike Falcon, so that your investigations stay aligned across both platforms.
19+
> **Warning:** Prerequisites
20+
> This tutorial assumes that you've already configured the ingestion of CrowdStrike Falcon detections and incidents into TheHive as alerts using [one of the available methods](crowdstrike-falcon-integrations.md#alert-ingestion).
1821
19-
!!! warning "Prerequisites"
20-
This tutorial assumes that you've already configured the ingestion of CrowdStrike Falcon detections and incidents into TheHive as alerts using [one of the available methods](crowdstrike-falcon-integrations.md#alert-ingestion).
22+
> **Note:** One-way sync
23+
> This synchronization only works from TheHive to CrowdStrike Falcon. If you want to sync statuses the other way around, you'll need to implement a polling mechanism using an alert feeder.
2124
22-
!!! note "One-way sync"
23-
This synchronization only works from TheHive to CrowdStrike Falcon. If you want to sync statuses the other way around, you’ll need to implement a polling mechanism using an [alert feeder](../../thehive/user-guides/organization/configure-organization/manage-feeders/about-feeders.md).
25+
**Status mapping:**
2426

25-
!!! info "Status mapping"
27+
| TheHive stage | CrowdStrike detection status | CrowdStrike incident status |
28+
| ----------- | ------------------------------------ | ------------------------------------ |
29+
| *New* | *new* | *20* |
30+
| *In progress* | *in_progress* | *30* |
31+
| *Closed* | *closed* | *40* |
2632

27-
| TheHive stage | CrowdStrike detection status | CrowdStrike incident status |
28-
| ----------- | ------------------------------------ | ------------------------------------ |
29-
| *New* | *new* | *20* |
30-
| *In progress* | *in_progress* | *30* |
31-
| *Closed* | *closed* | *40* |
32-
33-
!!! tip "More integration options"
34-
For the complete list of integration options between CrowdStrike Falcon and TheHive, see [CrowdStrike Falcon Integration with TheHive](crowdstrike-falcon-integrations.md).
33+
> **Tip:** More integration options
34+
> For the complete list of integration options between CrowdStrike Falcon and TheHive, see [CrowdStrike Falcon Integration with TheHive](crowdstrike-falcon-integrations.md).
3535
3636
## Step 1: Create custom fields in TheHive
3737

38-
<!-- md:permission `manageCase/update` --> <!-- md:permission `manageAlert/update` -->
39-
40-
To make the link between TheHive and CrowdStrike Falcon, we’ll start by [creating two custom fields](../../thehive/administration/custom-fields/create-a-custom-field.md) that will hold detection and incident IDs.
38+
To make the link between TheHive and CrowdStrike Falcon, we'll start by creating two custom fields that will hold detection and incident IDs.
4139

42-
1. {% include-markdown "includes/entities-management-view-go-to.md" %}
40+
1. Go to the **Entities management** view.
4341

44-
2. {% include-markdown "includes/custom-fields-tab-go-to.md" %}
42+
2. Select the **Custom fields** tab.
4543

46-
3. Select :fontawesome-solid-plus:.
44+
3. Select **+**.
4745

4846
4. In the **Adding a custom field** drawer, enter the following information:
4947

@@ -59,7 +57,7 @@ To make the link between TheHive and CrowdStrike Falcon, we’ll start by [creat
5957

6058
5. Select **Confirm custom field creation**.
6159

62-
6. Select :fontawesome-solid-plus: again.
60+
6. Select **+** again.
6361

6462
7. In the **Adding a custom field** drawer, enter the following information:
6563

@@ -77,9 +75,7 @@ To make the link between TheHive and CrowdStrike Falcon, we’ll start by [creat
7775

7876
## Step 2: Enable and configure the Status Sync responder in Cortex
7977

80-
<!-- md:permission `orgAdmin` -->
81-
82-
Now let’s enable and configure the *CrowdStrikeFalcon_Sync_1_0* responder in Cortex.
78+
Now let's enable and configure the *CrowdStrikeFalcon_Sync_1_0* responder in Cortex.
8379

8480
1. Go to the **Organization** view.
8581

@@ -89,26 +85,23 @@ Now let’s enable and configure the *CrowdStrikeFalcon_Sync_1_0* responder in C
8985

9086
4. Select **Edit** next to *CrowdStrikeFalcon_HostContainment_1_0*.
9187

92-
5. In the **Edit responder CrowdStrikeFalcon_HostContainment_1_0** drawer, enter the required details as described in the [Cortex Neurons documentation](https://thehive-project.github.io/Cortex-Analyzers/responders/CrowdstrikeFalcon/#crowdstrikefalcon_sync){target=_blank}.
88+
5. In the **Edit responder CrowdStrikeFalcon_HostContainment_1_0** drawer, enter the required details as described in the [Cortex Neurons documentation](https://thehive-project.github.io/Cortex-Analyzers/responders/CrowdstrikeFalcon/#crowdstrikefalcon_sync).
9389

9490
The responder is now ready to run and synchronize statuses each time a change is detected in TheHive.
9591

9692
## Step 3: Create a notification in TheHive to trigger the responder
9793

98-
<!-- md:permission `manageConfig` -->
94+
The last step is to automate the sync by triggering the responder when alert or case statuses change.
9995

100-
The last step is to automate the sync by [triggering the responder](../../thehive/user-guides/organization/configure-organization/manage-notifications/create-a-notification.md) when alert or case statuses change.
101-
102-
1. {% include-markdown "includes/organization-view-go-to.md" %}
96+
1. Go to the **Organization** view.
10397

104-
2. {% include-markdown "includes/notifications-tab-go-to.md" %}
98+
2. Select the **Notifications** tab.
10599

106-
3. Select :fontawesome-solid-plus:.
100+
3. Select **+**.
107101

108102
4. In the **Add notification** drawer, enter the name of your notification.
109103

110-
!!! warning "Unique name"
111-
This name must be unique, as two notifications can't have the same name.
104+
> **Warning:** This name must be unique, as two notifications can't have the same name.
112105
113106
5. Select the *FilteredEvent* trigger.
114107

@@ -165,6 +158,6 @@ The last step is to automate the sync by [triggering the responder](../../thehiv
165158

166159
Your system is now set up to synchronize statuses from TheHive to CrowdStrike Falcon whenever alert or case statuses are changed.
167160

168-
<h2>Next steps</h2>
161+
## Next steps
169162

170-
* [Cortex Responders GitHub repository](https://github.com/TheHive-Project/Cortex-Analyzers/tree/master/responders/CrowdstrikeFalcon){target=_blank}
163+
* [Cortex Responders GitHub repository](https://github.com/TheHive-Project/Cortex-Analyzers/tree/master/responders/CrowdstrikeFalcon)

0 commit comments

Comments
 (0)