This article shows how to leverage the Lumu Defender API and Harmony Endpoint Configuration API to mitigate security risks.

Requirements

• A Harmony Endpoint subscription.
• Administrative access is required to run the required configurations for enabling the integration
• Lumu Defender API key
  
• To retrieve an API token, please refer to the Defender API document.
  

• Script host.
• A scripting host is required to deploy the integration. This host must have Internet visibility over the Lumu Defender API endpoints and the Harmony Endpoint API endpoints. According to the deployment model you select, you will need a host with:
• Python 3.10+
  
• OR
  
• A Docker-enabled host.
  

• Script package
• Contact the Lumu support team to request the package we created to deploy the required files.

Setup Check Point Harmony Endpoint

Create an API Key

On Check Point Infinity portal go to Global Settings, then click on the API Keys submenu in the left panel:

1. Click on the New button. In the Create a new API key, set the Service field to Harmony Endpoint, fill out the Expiration, and Description.

2. For the Role field, select a role with entitlement to write/read actions as Admin, Primary Admin or Power User role.

Copy the details shown: Client ID, Secret Key, Authentication URL. These will be required later to configure the integration.

Deploy the integration

There are two environment options to deploy the script; select the one that fits better in your current infrastructure. Whatever alternative you select, you need to first unpack the integration package shared by our Support team. Unpack the deployment package provided by Lumu in your preferred path/folder. Keep in mind this location, as it will be required for further configurations. From now on, we will refer to this folder as <harmony_lumu_root>.

The integration works with Python 3.10. If your environment has prior versions, we recommend deploying the integration as a Docker Container.

Deploy as script

In the package, you will find the script required to run the integration. To use the script, you must locate yourself on the path selected for deployment (<harmony_lumu_root>). Specific directions are included in the next sections.

Install requirements

If you are running different Python scripts in the selected host, it’s recommended to create a virtual environment to preserve the integrity of other tools. To do so, follow these steps:

1. Using a command line tool, locate yourself in the <harmony_lumu_root> folder

2. Run the following command to create the virtual environment

python3 -m venv <venv_folder>

3. Activate the virtual environment running the following

source <venv_folder>/bin/activate

The file requirements.txt contains the list of requirements for this integration. After deploying the package locally, run the following command from the deployment folder:

Script details

To use the script, you must locate yourself on the path selected for deployment (<harmony_lumu_root>). Use the following command to show all options available for the package:

usage: harmony_endpoint_lumu.py [options]

Usage Examples

Task: query IoCs related to Lumu incidents for the last 30 days

To query all the IoCs related to Lumu incidents triggered in the last 30 days, run the following command.

Task: query IoCs related to Lumu incidents for the last X days

By default, the integration script will query incidents for the last 30 days. If you need to change this value, you can use the --days flag as follows.

In this example, the integration will query and push to Akamai ETP lists, IOCs related to incidents in the last 5 days

Task: query IoCs related to specific adversary types

By default, the integration script will query incidents related to all adversary types. If you need to filter the query to specific adversary types, you can use the --adversary-types flag as follows

In this example, the integration will query and push to Harmony Endpoint  lists, IOCs from incidents related to adversaries classified as C2C and Malware.

Task: query specific IoCs types

By default, the integration script will collect all the supported IOC types (IPs, domains, URLs, and hashes). If you need to filter the query to collect specific IOC types, you can use the --ioc-types flag as follows

In this example, the integration will query and push to Harmony Endpoint lists, URLs and hashes from Lumu incidents.

Task: run with .config file

You can run the integration using a configuration file where you can save the required arguments in the form of <argument_name>=<value>, one argument per line. In the <harmony_lumu_root> path, save a file named .config with your configuration. Following, you have a sample of the format of the file.

<hrmny_base_host> parameter is optional, if it is not set the app extract the data from <hrmny_ext_auth_url>

## Configuration file
# Lumu
company_key=<LUMU_COMPANY_KEY>
#  App
hrmny_ext_auth_url=<HARMONY_AUTH_URL>
hrmny_client_id=<HARMONY_CLIENT_ID>
hrmny_secret_key=<HARMONY_SECRET_KEY>
hrmny_base_host=[<HARMONY_BASE_HOST>]
# Misc
# Optional arguments
ioc-types=ip
ioc-types=url
ioc-types=domain
ioc-types=hash
# Optional arguments (default all adversary types)
adversary-types=C2C
adversary-types=Malware
adversary-types=Mining
adversary-types=Spam
adversary-types=Phishing
# Optional (default days: 30)
days=8
# Output trace destination. For Docker deployments leave this as screen
logging=[screen|file]

If you need to add flags (arguments without values like -v or --clean, those need to be added on the command line). In the repo files, you will find a sample file named .config_sample. You can tailor its content according to your needs. Remember to rename it to .config before running the integration script.

Task: Clean records

When the script is run with the –clean flag, it will erase all Lumu records created. Using this flag, you will return the Harmony Endpoint lists to their original state.

The records not manipulated by the integration will be preserved.

Other tasks

According to your needs, you can combine the examples shown.

Further considerations

To run the script on a timely basis, consider implementing a Scheduled task in Windows or a Cron task in Unix-based systems. If you are pushing hashes, the integration could take longer to run. We recommend that the scheduled job runs every 30 minutes.

Following, you have an example of how this Cron job should look using the recommended time.

It’s recommended to add the --logging file argument to any scheduled task. It will record all the output in the log file for further reference. If you have created a configuration file, your crontab entry doesn’t need arguments. It should look as follows:

If you need to work with another scheduling time, you can use the crontab guru service.

To avoid race conditions, you can run only one instance. If you have one running, the second one will be canceled immediately.

Deploy as a Docker container (Optional)

If you have a Docker environment, you can select this option to run the integration as a Docker process. To deploy and run your integration as a docker container, locate yourself at the <harmony_lumu_root> folder, and follow these instructions:

1. To build the container, run the following command. Change all the flags based on the reference given in the script section above.

docker build --build-arg hrmny_ext_auth_url='xxx' --build-arg hrmny_client_id='xxx' --build-arg hrmny_secret_key='xxx' --build-arg hrmny_base_host='xxx' --build-arg company_key='xxx' --tag python-lumu-harmony-response .

            Or

docker build --build-arg hrmny_ext_auth_url='xxx' --build-arg hrmny_client_id='xxx' --build-arg hrmny_secret_key='xxx' --build-arg company_key='xxx' --tag python-lumu-harmony-response .

Do not forget the dot "." at the end of the line

2. To run the container, run the following command:

docker run -d --restart unless-stopped --name lumu-harmony-response python-lumu-harmony-response

With this mode, your integration will run every 30 minutes.

Troubleshooting

For troubleshooting purposes, you can run the following commands:

To log in to your container using an interactive shell:

To collect integration logs:

Further steps

Make sure that your Threat Prevention Policy capabilities for Anti-Bot Mode in the Behavioral Protection section are set to Prevent.

Expected results

After running the integration, you will see Manage IoCs list over the Policy > Threat Prevention > Policy Capabilities -> Manage IoC module.

Check the records updated by the integration in the Manage IoCs Module. All IOCs added to this module will be blocked.

Troubleshooting and known issues

To identify failures in the script execution, use the -v flag. The script execution log will show more detailed information.

Another instance is running

If you receive the following error.

There could be another instance running. To check this, open the pid.pid file in the integration folder. This file stores the process id if it’s running. Search for this process in your system. The following pictures show the process in Windows and Linux.

Windows

Linux

If the previous validation indicates that another instance is running, please, check its progress using the integration’s log lumu.log.