Proofpoint On Demand Email Security Add-on
Overview
Details
The Proofpoint On Demand Email Security Add-on can be used with Proofpoint On Demand Email Security App that has builtin dashboards and reports for monitoring and reporting.
Release Notes
Version 1.0.0
Dec. 12, 2018
This add-on is designed to work with Proofpoint On Demand Email Security App.
Copyright (c) 2010-2019 by Proofpoint, Inc. All Rights Reserved.
Proofpoint, Proofpoint on Demand, Proofpoint Protection Server and the Proofpoint logos are trademarks or registered trademarks of Proofpoint, Inc.
Proofpoint On Demand Email Security Add-on
| About | Proofpoint On Demand Email Security Add-on |
| Developer | Proofpoint, Inc. |
| App Version | 2.6.0 |
| App | Proofpoint On Demand Email Security App |
| Folder Name | TA-pps_ondemand |
| Vendor Product | Proofpoint On Demand 8.0 and above |
| Has index-time operations | True |
| Create an index | False |
| Implements summarization | False |
| Splunk Enterprise versions | 9.4, 9.3, 9.2, 9.1 |
| CIM | 4.8+ |
| Platforms | Platform Independent |
| Requires Splunk Restart | Yes |
Installation and Configuration
Pre-requisites
- Splunk Enterprise (9.4, 9.3, 9.2, 9.1).
- Splunk Common Integration Model technology add-on 4.8 or above.
Apps supported by this app
- Proofpoint On Demand Email Security App available on Splunkbase (#4328)
- Proofpoint TAP SIEM Modular Input available on Splunkbase (#3681)
Proofpoint Products (One or more)
- Proofpoint On Demand 8.0 and above with PoD Log API access
- Target Attack Protection API access with API Service account and secret key
Product Configuration
- Proofpoint on Demand (PoD): PoD Log API service requires Remote Syslog Forwarding license. Please refer this document on how to enable and check PoD Log API: https://proofpointcommunities.force.com/community/s/article/Proofpoint-on-Demand-Pod-Log-API
Deployment
Single Server Deployment:
In a single server deployment, single instance of Splunk Enterprise functions as data collection node, indexer and search head. In such deployment, install Proofpoint On Demand Email Security Add-on and Proofpoint TAP SIEM Modular Input. After that, install Proofpoint On Demand Email Security App.
Distributed Deployment
In a distributed deployment, typically a combination of forwarders are deployed for data collection, separate indexer nodes for data ingestion and search heads for data visualization are deployed. We recommend installing our TA's on both Forwarder and Search heads and the App on the search head.
| Component | Heavy Forwarder | Indexer | Search head |
| Proofpoint On Demand Email Security Add-on | Install | No (Note) | Install |
| Proofpoint TAP SIEM Modular Input 1.0.1 available (TA) | Install | No (Note) | Install |
| Proofpoint On Demand Email Security App | No | No | Install |
Note: When there is no forwarder, you will have to install the Add-on on Indexer.
Proofpoint on Demand configuration
Contact Proofpoint support to enable PoD Log API capability. This requires Remote syslog license on your deployment.
Make sure you have the Cluster ID and API Key before you start configuring the Add-on. The cluster ID can be found top right corner of your Proofpoint on Demand admin console and it looks like customername_hosted. The API key is a long series of 200+ alpha numeric characters. Optionally you can check if the API key is valid using a curl command. Here is an example:
curl -i --no-buffer -k -v -H "Connection: Upgrade" -H "Upgrade: websocket" -H "Host: logstream.proofpoint.com:443" -H "Authorization: Bearer <APIKEY>" -H "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" -H "Sec-WebSocket-Version: 13" "https://logstream.proofpoint.com:443/v1/stream?cid=<cluster-id>&type=message"
Splunk Configuration
There are two steps to configure the Proofpoint On Demand Email Security Add-on. First, configure an account profile that would be used to connect to Proofpoint Log service. Second, configure mail and message inputs that would use the configured account profile to download logs and tokenize them. Here are the detailed steps:
- From the Splunk home page, click on "Proofpoint On Demand Email Security Add On"
- Click on the "Configuration" tab
- Add button
- Give an "Account Profile" name. For example, podlogapi
- For "Cluster ID" input your cluster name.
- For the "API Key" please past the API as received from Proofpoint. Please make sure to not add space or special character at the end of the API key.
Now that the account profile is created, next let's create input types.
- From the "Proofpoint On Demand Email Security Add On" app context, select the "Inputs" tab
- Select "Create New Input" on the right side, and select "Proofpoint Mail Log"
- On the next screen, for "Name" give a name for this log. For example, pps_mail_log
- Retry Interval, use 60 seconds. Please note that this retry setting is only used when the connection is lost. It's not a polling frequency as the logs are pushed using websocket from Proofpoint.
- For "Index", select the index you want the logs to be available on.
- For "Account Profile" select the account profile from previous step.
- Follow steps 2-6 again and create "Proofpoint Message Log" input type. Make sure the use the same index for both input types.
Verification
The Proofpoint On Demand logs are collected by the source type pps_maillog and pps_messagelog. In the search box you can verify the logs by searching for sourcetype="pps_maillog" and sourcetype="pps_messagelog". Note, if the sourcetypes are not created, that means there were no logs downloaded after the inputs were created.
Release Notes
Version 2.6.0
Added support for both KV-Service and KV-Store to enhance data collection, specifically designed to meet the needs of Splunk Cloud customers.
Migrated Add-on to latest AOB version 4.3.0.
Version 2.5.1
Updated Websocket library
Fixed issues related to session checkpoints which was causing data duplication and infinite archive streaming.
Version 2.5.0
Updated the checkpoint logic to avoid data duplication.
Updated field mapping with normalized fields
Enhanced connection logic
Version 2.4.0
Migrated to the latest Splunk add-on builder
Version 2.0.0
Updates in 2.0.0 release
1. Support for Splunk 8 with compatibility for both Python 2 and 3.
2. Minor changes to TLS dashboard.
3. Proofpoint Icon updated according to recent branding changes.
4. CIM mapping changes
Version 1.0.2
- Moved the API key validation to post configuration to handle slow KVStore deployments.
- Added a warning message when there are issues with KVStore
- Fixed an issue to handle Splunk deployment with IPv6 addresses