Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions docs/2-sensors-deployment/adapters/types/proofpoint-tap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Proofpoint TAP

## Overview

This Adapter allows you to connect to the [Proofpoint Targeted Attack Protection (TAP) SIEM API](https://help.proofpoint.com/Threat_Insight_Dashboard/API_Documentation/SIEM_API) to fetch email security events — blocked and delivered messages with threats, and blocked and permitted URL clicks.

## Deployment Configurations

All adapters support the same `client_options`, which you should always specify if using the binary adapter or creating a webhook adapter. If you use any of the Adapter helpers in the web app, you will not need to specify these values.

- `client_options.identity.oid`: the LimaCharlie Organization ID (OID) this adapter is used with.
- `client_options.identity.installation_key`: the LimaCharlie Installation Key this adapter should use to identify with LimaCharlie.
- `client_options.platform`: the type of data ingested through this adapter, like `text`, `json`, `gcp`, `carbon_black`, etc.
- `client_options.sensor_seed_key`: an arbitrary name for this adapter which Sensor IDs (SID) are generated from, see below.

### Adapter-specific Options

Adapter Type: `proofpoint_tap`

- `principal`: your Proofpoint TAP **Service Principal**.
- `secret`: the **Secret** paired with the Service Principal.

The adapter authenticates with HTTP Basic auth (`principal` / `secret`) and polls `https://tap-api-v2.proofpoint.com/v2/siem/all`.

### Getting Your Credentials

1. In the Proofpoint TAP dashboard, go to **Settings → Connected Applications**.
2. Create a **Service Principal**.
3. Copy the **Service Principal** (`principal`) and its **Secret** (`secret`).

### Infrastructure as Code Deployment

```python
# For cloud sensor deployment, store credentials as hive secrets:

# principal: "hive://secret/proofpoint-principal"
# secret: "hive://secret/proofpoint-secret"

sensor_type: "proofpoint_tap"
proofpoint_tap:
principal: "hive://secret/proofpoint-principal"
secret: "hive://secret/proofpoint-secret"
client_options:
identity:
oid: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
installation_key: "YOUR_LC_INSTALLATION_KEY_PROOFPOINT"
hostname: "proofpoint-tap-adapter"
platform: "proofpoint"
sensor_seed_key: "proofpoint-tap-sensor"
```

## API Doc

See the official [Proofpoint TAP SIEM API documentation](https://help.proofpoint.com/Threat_Insight_Dashboard/API_Documentation/SIEM_API).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ nav:
- Sophos: 2-sensors-deployment/adapters/types/sophos.md
- Carbon Black: 2-sensors-deployment/adapters/types/carbon-black.md
- Sublime Security: 2-sensors-deployment/adapters/types/sublime-security.md
- Proofpoint TAP: 2-sensors-deployment/adapters/types/proofpoint-tap.md
- ThreatLocker: 2-sensors-deployment/adapters/types/threatlocker.md
- Collaboration:
- Microsoft 365: 2-sensors-deployment/adapters/types/microsoft-365.md
Expand Down
Loading