Configuring Check Point Harmony Email Connectors

This connector allows Stellar Cyber to ingest logs from Check Point Harmony Email and add the records to the data lake. This connector integrates with the Harmony Email & Collaboration Smart API to query Security events.

Stellar Cyber connectors with the Collect function (collectors) may skip collecting some data when the ingestion volume is large, which potentially can lead to data loss. This can happen when the processing capacity of the collector is exceeded.

Connector Overview: Check Point Harmony Email

Capabilities

  • Collect: Yes

  • Respond: No

  • Native Alerts Mapped: Yes

  • Runs on: DP

  • Interval: Configurable

Collected Data

Content Type

Index

Locating Records

Security Event

Syslog

msg_class:

checkpoint_harmony_security_event

msg_origin.source:

checkpoint_harmony

msg_origin.vendor:

checkpoint

msg_origin.category:

email

Domain

<Base URL>

where <Base URL> is a variable from the configuration of this connector

Response Actions

N/A

Third Party Native Alert Integration Details

This connector ingests logs from Check Point Harmony Email to get the raw alerts that are stored in the Syslog index. Select the Security Event content type.

Stellar Cyber maps Check Point Harmony Email events. The events are read from the Syslog index, enriched with Stellar Cyber fields, and mapped (with deduplication) to the Alerts index.

Deduplication is by tenantid and checkpoint_harmony.eventId.

For details, see Integration of Third Party Native Alerts.

Required Credentials and Configurations

  • Base URL, API Key, and Domain ID

Locating Records

To search the alerts in the Alerts index or the Original Records in the Syslog index, use the query: (msg_class:\"checkpoint_harmony_security_event\") AND (checkpoint_harmony.type:(\"phishing\" OR \"malware\" OR \"alert\" OR \"dlp\") OR (checkpoint_harmony.severity:[4 TO *]) )

Adding a Check Point Harmony Email Connector

To add a Check Point Harmony Email connector:

  1. Obtain credentials
  2. Add the connector in Stellar Cyber
  3. Test the connector
  4. Verify ingestion

Obtaining Check Point Harmony Email Credentials

Before you configure the connector in Stellar Cyber, you must obtain the following Check Point Harmony Email credentials:

  • Base URL—The base URL for API access. The default is: https://cloudinfra-gw-us.portal.checkpoint.com

  • Client ID—The client ID part of the API Key. See Creating API Keys.

  • Access Key—The client secret part of the API Key. See Creating API Keys.

Creating API Keys

AN API Key consists of a client ID and client secret. When creating an API Key, make sure to select Harmony Email & Collaboration.

Follow the guidance in the Infinity Portal Administration Guide for API Keys. For example, the basic steps to create an Account API Key are:

  1. Log in to the Infinity Portal.

  2. Click the Gear icon (Settings).

  3. Select API Keys.

  4. Click New.

  5. Select New account API key.

  6. Select the Harmony Email & Collaboration service.

  7. Enter the information, such as Expiration and Description.

  8. Click Create.

  9. Copy the credentials.

    Store the credentials in a safe location.

  10. Click Close.

Adding the Connector in Stellar Cyber

To add a Check Point Harmony Email connector in Stellar Cyber:

  1. Log in to Stellar Cyber.

  2. Click System | INTEGRATIONS | Connectors. The Connector Overview appears.

  3. Click Create and select Connector.

    The General tab of the Add Connector screen appears. The information on this tab cannot be changed after you add the connector.

  4. Choose Email from the Category dropdown.

  5. Choose Check Point Harmony Email from the Type dropdown.

    The asterisk (*) indicates a required field.

  6. For this connector, the supported Function is Collect, which is enabled already.

  7. Enter a Name.

    Notes:
    • This field does not accept multibyte characters.
    • It is recommended that you follow a naming convention such as tenantname-connectortype.

  8. Choose a Tenant Name. The Interflow records created by this connector include this tenant name.

  9. Choose the device on which to run the connector.

  10. (Optional) When the Function is Collect, you can apply Log Filters. For information, see Managing Log Filters.

  11. Click Next. The Configuration tab appears.

    The asterisk (*) indicates a required field.

  12. Enter the Base URL you noted above in Obtaining Check Point Harmony Email Credentials.

  13. Enter the Client ID you noted above.

  14. Enter the Access Key you noted above.

  15. Choose the Interval (min). This is how often the logs are collected.

  16. (Optional) Click Disable SSL Certificate Verification if you want to disable SSL certificate verification. Only disable SSL certificates if you have a reason to, otherwise, it is not a good security practice.

  17. Choose the Content Type you would like to collect. The logs for Security Event are supported.

  18. Click Next. The final confirmation tab appears.

  19. Click Submit.

The new connector is immediately active.

Testing the Connector

In addition to testing for connectivity, the Test button for the Check Point Harmony Email connector tests that the Base URL, Client ID, and Access Key are correct and data requests for the requested content types return successful responses.

When you add (or edit) a connector, we recommend that you run a test to validate the connectivity parameters you entered. The test validates authentication and connectivity.

For connectors running on a sensor, Stellar Cyber recommends that you allow 30-60 seconds for new or modified configuration details to be propagated to the sensor before performing a test.

  1. Click System | INTEGRATIONS | Connectors. The Connector Overview appears.

  2. Locate the connector by name that you added, or modified, or that you want to test.

  3. Click Test at the right side of that row. The test runs immediately.

    Note that you may run only one test at a time.

Stellar Cyber conducts a basic connectivity test for the connector and reports a success or failure result. A successful test indicates that you entered all of the connector information correctly.

To aid troubleshooting your connector, the dialog remains open until you explicitly close it by using the X button. If the test fails, you can select the  button from the same row to review and correct issues.

The connector status is updated every five (5) minutes. A successful test clears the connector status, but if issues persist, the status reverts to failed after a minute.

Repeat the test as needed.

ClosedDisplay sample messages...

Success !

Failure with summary of issue:

Show More example detail:

If the test fails, the common HTTP status error codes are as follows:

HTTP Error Code HTTP Standard Error Name Explanation Recommendation
400 Bad Request This error occurs when there is an error in the connector configuration.

Did you configure the connector correctly?
401 Unauthorized

This error occurs when an authentication credential is invalid or when a user does not have sufficient privileges to access a specific API.

Did you enter your credentials correctly?

Are your credentials expired?

Are your credentials entitled or licensed for that specific resource?
403 Forbidden This error occurs when the permission or scope is not correct in a valid credential.

Did you enter your credentials correctly?

Do you have the required role or permissions for that credential?

404 Not Found This error occurs when a URL path does not resolve to an entity. Did you enter your API URL correctly?
429 Too Many Requests

This error occurs when the API server receives too much traffic or if a user’s license or entitlement quota is exceeded.

The server or user license/quota will eventually recover. The connector will periodically retry the query.

If this occurs unexpectedly or too often, work with your API provider to investigate the server limits, user licensing, or quotas.

For a full list of codes, refer to HTTP response status codes.

Verifying Ingestion

To verify ingestion:

  1. Select Threat Hunting.

    The Interflow Search tab appears.

  2. Change the Indices to Syslog.

    The table immediately updates to show ingested Interflow records.