Proofpoint Protection Server
LAST UPDATED: OCT 08, 2024
Overview
Proofpoint Protection Server is an email security gateway that protects organizations from spam, phishing attacks, and malware threats. With filtering techniques and real-time threat detection, providing comprehensive protection for email communication. This integration can be used to manage your email security gateway appliance.
D3 SOAR is providing REST operations to function with Proofpoint Protection Server. Proofpoint Protection Server is available for use in:
D3 SOAR | V16.8+ |
Category | Email Security |
Deployment Options |
Connection
To connect to Proofpoint Protection Server from D3 SOAR, follow this part to collect the required information below:
Parameter | Description | Example |
Server URL | The API server URL for the API connection at domain level. The default API service port is 10000. | https://localhost:10000 |
Username | The username for authenticating the API connection. | apiadmin |
Password | The password used for authenticating the API connection. | ***** |
Permission Requirements
Each endpoint in the Proofpoint Protection Server API requires a certain permission scope. The following are minimum required permissions for the commands in this integration:
Commands | Required Permissions | |
Role | Managed Modules | |
Delete Quarantine Messages | Type: API | Quarantine |
Fetch Event | Type: API | Quarantine |
Get Users | Type: API | enduser |
Release Quarantine Messages | Type: API | Quarantine |
Test Connection | Type: API | Quarantine |
Update Users | Type: API | enduser |
Configuring D3 SOAR to Work with Proofpoint Protection Server
Log in to D3 SOAR.
Find the Proofpoint Protection Server integration.
Navigate to Configuration on the top header menu.
Click on the Integration icon on the left sidebar.
Type Proofpoint Protection Server in the search box to find the integration, then click it to select it.
Click on the + Connection button on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Proofpoint Protection Server.
Connection Name: The desired name for the connection.
Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.
Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
Description (Optional): Add your desired description for the connection.
Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.
Configure User Permissions: Defines which users have access to the connection.
Active: Check the checkbox to ensure the connection is available for use.
System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
1. Input the Server URL.2. Input the Username.
3. Input the Password.
4. Input the API Version. The default value is v1.
Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
To set up a connection health check, check the Connection Health Check tick box. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.
Test the connection.
Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green check mark appear beside the Test Connection button. If the test connection fails, check your connection parameters and try again.
Click OK to close the alert window.
Click + Add to create and add the configured connection.
Commands
Proofpoint Protection Server includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.
Integration API Note
For more information about the Proofpoint Protection Server API, refer to the Proofpoint Protection Server API reference.
READER NOTE
Certain permissions are required for each command. Refer to the Permission Requirements section for details.
Note for Time-related parameters
The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:
Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose your desired date and time format, then click on the Save button.
After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.
Delete Quarantine Messages
Deletes the specified messages from the quarantine folder. The messages can be removed from their folder and be moved to a "Deleted Folder."
READER NOTE
Local GUIDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Local GUIDs. Local GUIDs can be found in the raw data at the path $.records[*].localguid.
Input
Input Parameter | Required/Optional | Description | Example |
Folder Name | Required | The name of the folder in which the messages are stored. | HIPAA |
Local GUIDs | Required | Local GUIDs in the format folder_id:table_id:dbase_id (e.g., "2:2:8"). In Cloud Quarantine mode, the format is GUID (e.g., "g5fsnj_sDLMk9hECaJwccxwP6lQkr5k6"). Local GUIDs can be obtained using the Fetch Event command. |
JSON
|
Deleted Folder | Optional | The name of the folder to which the messages will be moved. If specified, the folder must correspond to quarantined messages from the same module type. For example, deleted spam messages cannot be moved to a folder for deleted DLP incidents, and vice versa. | Deleted Incidents |
Output
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Delete Quarantine Messages failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Proofpoint Protection Server portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Server URL is not valid in format. |
Error Sample Data Delete Quarantine Messages failed. Status Code: 400. Message: Server URL is not valid in format. |
Fetch Event
Ingests quarantined messages as events based on the specified parameters. The returned messages are sorted by date/time in descending order (newest first), along with DLP violation details and message status.
READER NOTE
At least one of the parameters—Subject, Sender, or Recipient—must be specified.
Input
Input Parameter | Required/Optional | Description | Example |
Start Time | Optional | The date and time to begin the search for quarantined messages, in UTC. By default, the value is set to 1 day before the End Time. | 2024-010-05 18:00:00 |
End Time | Optional | The date and time to conclude the search for quarantined messages, in UTC. By default, the value is the current time. | 2024-10-05 18:59:59 |
Subject | Optional | Filters quarantined messages based on whether the message subject starts with, ends with, or contains the specified sequence of characters. At least one of the parameters—Subject, Sender, or Recipient—must be specified. | 20*$1000 Payday Loans* |
Sender | Optional | Filters quarantined messages based on whether the envelope message sender equals, starts with, ends with the specified sequence of characters, or originates from a specified domain (e.g., bar.com). | *john@doe.com |
Recipient | Optional | Filters quarantined messages based on whether the envelope message recipient equals, starts with, ends with the specified sequence of characters, or originates from a specified domain (e.g., bar.com). | @*****.***** |
Folder | Optional | Filters quarantined messages based on the quarantine folder name. By default, the folder will be "Quarantine." | Adult |
Message GUID | Optional | The message global unique identifier (generated by PPS) used to retrieve the raw data for a message. If specified and the message is found, the response body will contain the message's raw data instead of a JSON object. Do not use this parameter for data ingestion. | 3F2*****3301 |
Output
Fetch Event Field Mapping
Fetch Event commands require event field mapping. Field mapping plays a key role for data normalization within the event pipeline. Field mapping converts the original data fields from the different providers to standardized D3 fields as defined by the D3 Model. Refer to Event and Incident Intake Field Mapping for details.
To customize field mapping, click + Add Field and add the custom field of your choice. You can also remove built-in field mappings by clicking x. Note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.
As a system integration, the Proofpoint Protection Server integration has some pre-configured field mappings for default field mapping.
Default Event Source
The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a "Main Event JSON Path" (i.e. $.records) that is used to extract a batch of events from the response raw data. Click Edit Main JSON Path to view the "Main Event JSON Path".Main Event JSON Path: $.records
The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $.records, representing the root element. The path is formed by appending a sequence of child elements to $.records, each separated by a dot (.). Square brackets with nested quotation marks ([‘*****’]) should be used to separate child elements in JSON arrays.
For example, the root node of a JSON Path is $.records and the child node denoting the Document ID field is .guid. Putting it together, the JSON Path expression to extract the Document ID is $.records.guid.
The pre-configured field mappings are detailed below:
Field Name | Source Field |
Document ID | .guid |
Filename | .dlpviolation.components.files[*].name |
Hostname | .host_ip |
Internal message ID | .localguid |
Start Time | .date |
Description | .dlpviolation.reasons[*].name |
Message ID | .messageid |
Message size | .size |
Recipient | .rcpts |
Rule name | .dlpviolation.reasons[*].name |
Sender | .from |
Severity | .dlpviolation.reasons[*].severity |
Source IP address | .dlpviolation.components.events[*].ip |
Source | .dlpviolation.source |
Status | .messagestatus[0].statusdesc |
Sub Event | .messagestatus |
Email subject | .subject |
Username | .dlpviolation.components.users[*].email |
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Fetch Event failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Proofpoint Protection Server portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Server URL is not valid in format. |
Error Sample Data Fetch Event failed. Status Code: 400. Message: Server URL is not valid in format. |
Get Users
Retrieves the end user resource associated with the specified email addresses or UID.
Input
Input Parameter | Required/Optional | Description | Example |
User Emails or IDs | Required | The email addresses or IDs of the end users. The user must exist in the Proofpoint Protection Server User Repository. | [ "*****@*****.*****" ] |
Output
Error Handling
If the Return Data displays Partially Successful or Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Get Users failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Proofpoint Protection Server portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Server URL is not valid in format. |
Error Sample Data Get Users failed. Status Code: 400. Message: Server URL is not valid in format. |
Release Quarantine Messages
Releases the message to the email infrastructure without additional scanning. The messages can remain in their folder or be moved to a "Deleted Folder."
READER NOTE
Local GUIDs is a required parameter to run this command.
Run the Fetch Event command to obtain the Local GUIDs. Local GUIDs can be found in the raw data at the path $.records[*].localguid.
Input
Input Parameter | Required/Optional | Description | Example |
Folder Name | Required | The name of the folder in which the messages are stored. | HIPAA |
Local GUIDs | Required | Local GUIDs in the format folder_id:table_id:dbase_id (e.g., "2:2:8"). In Cloud Quarantine mode, the format is GUID (e.g., "g5fsnj_sDLMk9hECaJwccxwP6lQkr5k6"). Local GUIDs can be obtained using the Fetch Event command. |
JSON
|
Deleted Folder | Optional | The name of the folder to which the messages will be moved. If specified, the folder must correspond to quarantined messages from the same module type. For example, deleted spam messages cannot be moved to a folder for deleted DLP incidents, and vice versa. | Deleted Incidents |
Enable Rescan | Optional | Whether to rescan the messages using the DLP and Attachment Defense filtering modules. By default, the value is False. | True |
Brand Template | Optional | When Encryption is licensed, the Branding Template will be used when the encrypted message(s) is released. The Branding Templates are listed on the System > End User Services > Branding Templates page in the management interface (admin GUI). If specified with "sender", the message(s) will be encrypted and released using the sender’s Branding Template. | System_Default_Encryption_Branding |
Security Policy | Optional | The Secure Reader response profile to use when release is used for encrypted message(s). The Response Profiles are listed on the Information Protection > Encryption > Response Profiles page in the management interface (admin GUI). If specified with "sender", the message(s) will be encrypted and released using the sender’s response profile. | System_Response_Profile |
Output
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Release Quarantine Messages failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Proofpoint Protection Server portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Server URL is not valid in format. |
Error Sample Data Release Quarantine Messages failed. Status Code: 400. Message: Server URL is not valid in format. |
Update Users
Modifies the user profiles for the specified users.
Input
Input Parameter | Required/Optional | Description | Example |
User Emails or IDs | Required | The email addresses or IDs of the end users to update. The user must exist in the Proofpoint Protection Server User Repository. |
JSON
|
Fields | Optional | The fields to be updated. |
JSON
|
Attributes | Optional | The attributes to be updated in the table. Invalid attributes will be ignored. Attribute names are case-sensitive. |
JSON
|
Output
Error Handling
If the Return Data displays Partially Successful or Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Update Users failed. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Proofpoint Protection Server portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Server URL is not valid in format. |
Error Sample Data Update Users failed. Status Code: 400. Message: Server URL is not valid in format. |
Test Connection
Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.
Input
N/A
Output
Error Handling
If the Return Data displays Failed, an Error tab will appear in the Test Result window.
The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.
Parts in Error | Description | Example |
Failure Indicator | Indicates the command failure that happened at a specific input and/or API call. | Test Connection failed. Failed to check the connector. |
Status Code | The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Proofpoint Protection Server portal. Refer to the HTTP Status Code Registry for details. | Status Code: 400. |
Message | The raw data or captured key error message from the integration API server about the API request failure. | Message: Bad Request |
Error Sample Data Test Connection failed. Failed to check the connector. Status Code: 400. Message: Bad Request |