Skip to content

Commit 9dea72d

Browse files
Proofpoint use-cases update
1 parent 87724d0 commit 9dea72d

2 files changed

Lines changed: 50 additions & 38 deletions

File tree

integrations/vendors/Proofpoint/use-cases/alert-ingestion-clicksPermitted.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,48 @@
22
title: Ingest Proofpoint ClicksPermitted Events into TheHive Using an Alert Feeder
33
description: Ingest Proofpoint TAP clicksPermitted events as TheHive alerts to track and respond to users who clicked on malicious links that were not blocked by Proofpoint and may require investigation.
44
tags: [proofpoint, tap, clicksPermitted, alert-ingestion]
5-
thehive_version_required : "5.5"
6-
license_required : "platinum"
7-
linked_to : ["integrations/vendors/Proofpoint/thehive/functions/function_Feeder_alertFromProofpoint_clicksPermitted.js"]
5+
thehive_version_required: "5.5"
6+
license_required: "platinum"
7+
linked_to: ["integrations/vendors/Proofpoint/thehive/functions/function_Feeder_alertFromProofpoint_clicksPermitted.js"]
88
---
99
# Tutorial: Ingest Proofpoint ClicksPermitted Events into TheHive Using an Alert Feeder
1010

11-
<!-- md:permission `manageConfig` --> <!-- md:integration Native --> <!-- md:version 5.5 --> <!-- md:license Platinum -->
12-
13-
{% include-markdown "includes/alert-feeder-proofpoint-tap-not-tested-live.md" %}
11+
> **Warning:** This alert feeder has not been tested in a live Proofpoint TAP environment. Please verify its behavior before using it in production.
1412
1513
In this tutorial, we're going to configure an alert feeder that ingests Proofpoint Targeted Attack Protection (TAP) `clicksPermitted` events as TheHive alerts.
1614

1715
By the end, you'll have a working setup to track and respond to users who clicked on malicious links that weren't blocked by Proofpoint.
1816

19-
!!! tip "More integration options"
20-
For the complete list of integration options between Proofpoint and TheHive, see [Proofpoint Integration with TheHive](proofpoint-integrations.md).
17+
> **Tip:** More integration options
18+
> For the complete list of integration options between Proofpoint and TheHive, see [Proofpoint Integration with TheHive](proofpoint-integrations.md).
19+
20+
## Step 1: Get your Proofpoint TAP service credentials
21+
22+
To connect TheHive to the Proofpoint TAP API, you need a **service principal** and **service secret** from your Proofpoint TAP dashboard.
23+
24+
1. Log in to your [Proofpoint TAP dashboard](https://threatinsight.proofpoint.com/).
25+
26+
2. Go to **Settings** > **Connected Applications**.
27+
28+
3. Generate a new **service credential** if you don't already have one.
2129

22-
{% include-markdown "includes/tap-service-credentials.md" %}
30+
4. Copy and save the **service principal** and **service secret**. You'll need them in the next step.
2331

2432
## Step 2: Create an alert feeder in TheHive
2533

26-
To ingest Proofpoint `clicksPermitted` events into TheHive, you need to [create an alert feeder](../../thehive/user-guides/organization/configure-organization/manage-feeders/create-a-feeder.md) that queries the Proofpoint SIEM API and transforms the results into alerts.
34+
To ingest Proofpoint `clicksPermitted` events into TheHive, you need to create an alert feeder that queries the Proofpoint SIEM API and transforms the results into alerts.
2735

28-
1. {% include-markdown "includes/organization-view-go-to.md" %}
36+
1. Go to the **Organization** view.
2937

30-
2. {% include-markdown "includes/connectors-tab-organization-go-to.md" %}
38+
2. Select the **Connectors** tab.
3139

3240
3. In the **General settings** section, enter the following information:
3341

3442
**- Name**: *ProofpointTAPAlertIngestion-clicksPermitted*
3543

3644
**- Interval**: How often the alert feeder sends requests to the external system.
3745

38-
!!! warning "Define the interval carefully based on your reactivity requirements"
39-
Make sure the interval is shorter than the processing time to avoid potential issues, but not too short to prevent excessive requests to the API.
46+
> **Warning:** Define the interval carefully based on your reactivity requirements. Make sure the interval is shorter than the processing time to avoid potential issues, but not too short to prevent excessive requests to the API.
4047
4148
**- Request timeout time**: The maximum time, in seconds, the alert feeder waits for a response before timing out.
4249

@@ -60,8 +67,7 @@ To ingest Proofpoint `clicksPermitted` events into TheHive, you need to [create
6067

6168
6. In the **Create function** section, enter the following information:
6269

63-
!!! info "Feeder function"
64-
Once created, the function is automatically added to the [functions list](../../thehive/user-guides/organization/configure-organization/manage-functions/about-functions.md) with the type *feeder*.
70+
> **Note:** Once created, the function is automatically added to the functions list with the type *feeder*.
6571
6672
**- Function name**: *ProofpointClicksPermitted*
6773

@@ -194,14 +200,14 @@ To ingest Proofpoint `clicksPermitted` events into TheHive, you need to [create
194200
}
195201
```
196202

197-
7. {% include-markdown "includes/test-function.md" %}
203+
7. Select **Test** to verify the function works as expected.
198204

199205
8. Select **Confirm**.
200206

201-
For more details, see the [Proofpoint SIEM API official documentation](https://help.proofpoint.com/Threat_Insight_Dashboard/API_Documentation/SIEM_API){target=_blank}.
207+
For more details, see the [Proofpoint SIEM API official documentation](https://help.proofpoint.com/Threat_Insight_Dashboard/API_Documentation/SIEM_API).
202208

203209
At this point, your alert feeder should be operational and TheHive will start ingesting `clicksPermitted` events as alerts.
204210

205-
<h2>Next steps</h2>
211+
## Next steps
206212

207213
* [Ingest Proofpoint messagesDelivered Events into TheHive Using an Alert Feeder](ingest-proofpoint-messagesdelivered-events.md)

integrations/vendors/Proofpoint/use-cases/alert-ingestion-messageDelivered.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,48 @@
22
title: Ingest Proofpoint MessagesDelivered Events into TheHive Using an Alert Feeder
33
description: Ingest Proofpoint TAP messagesDelivered events as TheHive alerts to track and respond to threats that have reached user mailboxes and may require investigation.
44
tags: [proofpoint, tap, messagesDelivered, alert-ingestion]
5-
thehive_version_required : "5.5"
6-
license_required : "platinum"
7-
linked_to : ["integrations/vendors/Proofpoint/thehive/functions/function_Feeder_alertFromProofpoint_messageDelivered.js"]
5+
thehive_version_required: "5.5"
6+
license_required: "platinum"
7+
linked_to: ["integrations/vendors/Proofpoint/thehive/functions/function_Feeder_alertFromProofpoint_messageDelivered.js"]
88
---
99
# Tutorial: Ingest Proofpoint MessagesDelivered Events into TheHive Using an Alert Feeder
1010

11-
<!-- md:permission `manageConfig` --> <!-- md:integration Native --> <!-- md:version 5.5 --> <!-- md:license Platinum -->
12-
13-
{% include-markdown "includes/alert-feeder-proofpoint-tap-not-tested-live.md" %}
11+
> **Warning:** This alert feeder has not been tested in a live Proofpoint TAP environment. Please verify its behavior before using it in production.
1412
1513
In this tutorial, we're going to configure an alert feeder that ingests Proofpoint Targeted Attack Protection (TAP) `messagesDelivered` events as TheHive alerts.
1614

1715
By the end, you'll have a working setup to track threats that reached user mailboxes and may require investigation or response.
1816

19-
!!! tip "More integration options"
20-
For the complete list of integration options between Proofpoint and TheHive, see [Proofpoint Integration with TheHive](proofpoint-integrations.md).
17+
> **Tip:** More integration options
18+
> For the complete list of integration options between Proofpoint and TheHive, see [Proofpoint Integration with TheHive](proofpoint-integrations.md).
19+
20+
## Step 1: Get your Proofpoint TAP service credentials
21+
22+
To connect TheHive to the Proofpoint TAP API, you need a **service principal** and **service secret** from your Proofpoint TAP dashboard.
23+
24+
1. Log in to your [Proofpoint TAP dashboard](https://threatinsight.proofpoint.com/).
25+
26+
2. Go to **Settings** > **Connected Applications**.
27+
28+
3. Generate a new **service credential** if you don't already have one.
2129

22-
{% include-markdown "includes/tap-service-credentials.md" %}
30+
4. Copy and save the **service principal** and **service secret**. You'll need them in the next step.
2331

2432
## Step 2: Create an alert feeder in TheHive
2533

26-
To ingest Proofpoint `messagesDelivered` events into TheHive, you need to [create an alert feeder](../../thehive/user-guides/organization/configure-organization/manage-feeders/create-a-feeder.md) that queries the Proofpoint SIEM API and transforms the results into alerts.
34+
To ingest Proofpoint `messagesDelivered` events into TheHive, you need to create an alert feeder that queries the Proofpoint SIEM API and transforms the results into alerts.
2735

28-
1. {% include-markdown "includes/organization-view-go-to.md" %}
36+
1. Go to the **Organization** view.
2937

30-
2. {% include-markdown "includes/connectors-tab-organization-go-to.md" %}
38+
2. Select the **Connectors** tab.
3139

3240
3. In the **General settings** section, enter the following information:
3341

3442
**- Name**: *ProofpointTAPAlertIngestion-messagesDelivered*
3543

3644
**- Interval**: How often the alert feeder sends requests to the external system.
3745

38-
!!! warning "Define the interval carefully based on your reactivity requirements"
39-
Make sure the interval is shorter than the processing time to avoid potential issues, but not too short to prevent excessive requests to the API.
46+
> **Warning:** Define the interval carefully based on your reactivity requirements. Make sure the interval is shorter than the processing time to avoid potential issues, but not too short to prevent excessive requests to the API.
4047
4148
**- Request timeout time**: The maximum time, in seconds, the alert feeder waits for a response before timing out.
4249

@@ -60,8 +67,7 @@ To ingest Proofpoint `messagesDelivered` events into TheHive, you need to [creat
6067

6168
6. In the **Create function** section, enter the following information:
6269

63-
!!! info "Feeder function"
64-
Once created, the function is automatically added to the [functions list](../../thehive/user-guides/organization/configure-organization/manage-functions/about-functions.md) with the type *feeder*.
70+
> **Note:** Once created, the function is automatically added to the functions list with the type *feeder*.
6571
6672
**- Function name**: *ProofpointMessagesDelivered*
6773

@@ -210,14 +216,14 @@ To ingest Proofpoint `messagesDelivered` events into TheHive, you need to [creat
210216
}
211217
```
212218

213-
7. {% include-markdown "includes/test-function.md" %}
219+
7. Select **Test** to verify the function works as expected.
214220

215221
8. Select **Confirm**.
216222

217-
For more details, see the [Proofpoint SIEM API official documentation](https://help.proofpoint.com/Threat_Insight_Dashboard/API_Documentation/SIEM_API){target=_blank}.
223+
For more details, see the [Proofpoint SIEM API official documentation](https://help.proofpoint.com/Threat_Insight_Dashboard/API_Documentation/SIEM_API).
218224

219225
At this point, your alert feeder should be operational and TheHive will start ingesting `messagesDelivered` events as alerts.
220226

221-
<h2>Next steps</h2>
227+
## Next steps
222228

223229
* [Ingest Proofpoint clicksPermitted Events into TheHive Using an Alert Feeder](ingest-proofpoint-clickspermitted-events.md)

0 commit comments

Comments
 (0)