# Collect Forcepoint NGFW logs

**Parser Version:** 16.0
Supported in:

This document explains how to ingest Forcepoint NGFW logs to Google Security Operations using the Bindplane agent.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance
- A Windows 2016 or later or Linux host with `systemd`
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to the Forcepoint Security Management Center (SMC)

## Get Google SecOps credentials for the Bindplane agent

To authenticate the Bindplane agent to Google SecOps, choose one of the following methods:

- **New deployments**: Use the Chronicle API (Option 1).
- **Legacy deployments**: Continue using the ingestion authentication file (Option 2) until the Ingestion API is discontinued on July 20, 2027.

### Option 1: Create a service account for the Chronicle API (recommended)

1. Sign in to the [Google Cloud console](https://console.cloud.google.com/) and select the Google Cloud project that is linked to your Google SecOps instance.
2. Go to **IAM \& Admin \> Service Accounts**.
3. Click **Create service account**.
4. Provide the following configuration details:
   - **Service account name** : Enter a name for the account (for example, `bindplane-ingest`).
   - **Service account description** : Enter a description (for example, `Bindplane agent log ingestion`).
5. Click **Create and continue**.
6. In the **Grant this service account access to project** section, click **Select a role** and select **Chronicle Editor**.
7. Click **Continue** , and then click **Done**.
8. Click the service account you created, and then go to the **Keys** tab.
9. Click **Add key \> Create new key**.
10. Select **JSON** and click **Create**. The key file is downloaded to your computer.
11. Save the key file as `ingestion-auth.json` in the Bindplane collector directory (`/opt/observiq-otel-collector/ingestion-auth.json` on Linux or `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json` on Windows), or update `creds_file_path` in `config.yaml` to match the path where you save it.
12. Go to **IAM \& Admin \> Settings** and copy the **Project number**. You'll need it for the exporter configuration.

> [!NOTE]
> **Note:** The JSON key is a credential. Restrict access to the file on the Bindplane host and rotate the key according to your organization's policy.

### Option 2: Download the ingestion authentication file (legacy)

1. Sign in to the Google SecOps console.
2. Go to **Settings \> Data Management \> Collection Agents** . If you are on a SIEM-only platform, go to **Settings \> Collection Agents**.
3. Download the **ingestion authentication file**.
4. Save the file securely on the system where the Bindplane agent will be installed.

> [!NOTE]
> **Note:** This file authenticates the agent to the legacy Ingestion API (`malachiteingestion-pa.googleapis.com`), which Google has scheduled for end of life on July 20, 2027. Plan to move to Option 1 before that date.

## Get Google SecOps customer ID

1. Sign in to the Google SecOps console.
2. Go to **Settings \> Administration \> Profile** . If you are on a SIEM-only platform, go to **Settings \> Profile**.
3. Copy and save the **Customer ID** from the **Organization Details** section.

## Install the Bindplane agent

Install the Bindplane agent on your Windows or Linux operating system according to the following instructions.

### Windows installation

1. Open the **Command Prompt** or **PowerShell** as an administrator.
2. Run the following command:

       msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

### Linux installation

1. Open a terminal with root or sudo privileges.
2. Run the following command:

       sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

### Additional installation resources

For additional installation options, see the [Bindplane agent installation guide](https://docs.cloud.google.com/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).

> [!NOTE]
> **Note:** The Chronicle API exporter configuration requires Bindplane collector v1.106.0 or later. The previous commands install the latest release. If you're updating an existing installation, upgrade the collector before changing the configuration.

## Configure the Bindplane agent to ingest Syslog and send to Google SecOps

1. Access the configuration file:

   - Locate the `config.yaml` file. Typically, it's in the `/opt/observiq-otel-collector/` directory on Linux or in the installation directory on Windows.
   - Open the file using a text editor (for example, `nano`, `vi`, or Notepad).
2. Edit the `config.yaml` file as follows:

       receivers:
         tcplog:
           # Replace the port and IP address as required
           listen_address: "0.0.0.0:514"

       exporters:
         chronicle/chronicle_w_labels:
           protocol: https
           # Region of your instance, for example us, europe, asia-southeast1
           location: <LOCATION>
           # Project number of the Google Cloud project linked to the instance
           project: '<PROJECT_NUMBER>'
           compression: gzip
           # Adjust the path to the credentials file you downloaded in Step 1
           creds_file_path: '/path/to/ingestion-authentication-file.json'
           # Replace with your actual customer ID from Step 2
           customer_id: YOUR_CUSTOMER_ID
           endpoint: chronicle.googleapis.com
           # Add optional ingestion labels for better organization
           log_type: 'FORCEPOINT_FIREWALL'
           raw_log_field: body
           ingestion_labels:

       service:
         pipelines:
           logs/source0__chronicle_w_labels-0:
             receivers:
               - tcplog
             exporters:
               - chronicle/chronicle_w_labels

   - Replace the port and IP address as required in your infrastructure.
   - Replace `<LOCATION>` with the region of your Google SecOps instance (for example, `us`, `europe`, or `asia-southeast1`). The exporter prefixes `chronicle.googleapis.com` with this value.
   - Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.
   - Replace `YOUR_CUSTOMER_ID` with the actual Customer ID.
   - Update `/path/to/ingestion-authentication-file.json` to the file path where the service account key file (Option 1) was saved in Step 1.

   > [!NOTE]
   > **Note:** You can use `udplog` instead of `tcplog` if your environment requires UDP transport. Adjust the receiver name accordingly in both the `receivers` and `service.pipelines` sections.

### Legacy ingestion API exporter

- If you use the ingestion authentication file from Option 2, replace the `exporters` block with the following. Set `creds_file_path` to the path to the ingestion authentication file, and if your instance is outside the US, replace `malachiteingestion-pa.googleapis.com` with your [regional endpoint](https://docs.cloud.google.com/chronicle/docs/reference/ingestion-api#regional-endpoints) (for example, `europe-malachiteingestion-pa.googleapis.com`).

      exporters:
        chronicle/chronicle_w_labels:
          compression: gzip
          # Adjust the path to the credentials file you downloaded in Step 1
          creds_file_path: '/path/to/ingestion-authentication-file.json'
          # Replace with your actual customer ID from Step 2
          customer_id: YOUR_CUSTOMER_ID
          endpoint: malachiteingestion-pa.googleapis.com
          # Add optional ingestion labels for better organization
          log_type: 'FORCEPOINT_FIREWALL'
          raw_log_field: body
          ingestion_labels:

> [!NOTE]
> **Note:** This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

## Restart the Bindplane agent to apply the changes

1. To restart the Bindplane agent in **Linux**, run the following command:

       sudo systemctl restart observiq-otel-collector

2. To restart the Bindplane agent in **Windows** , you can either use the **Services** console or enter the following command:

       net stop observiq-otel-collector && net start observiq-otel-collector

## Configure Syslog forwarding on Forcepoint NGFW

1. Sign in to the **Forcepoint Security Management Center (SMC)**.
2. Go to **Configuration \> Log Server \> Properties**.
3. Navigate to the **Log Forwarding** section.
4. Click **Add** to create a new forwarding rule.
5. Provide the following configuration details:
   - **Name** : Enter a descriptive name (for example, `Google SecOps Bindplane Syslog`).
   - **Host**: Enter the Bindplane agent IP address.
   - **Port** : Enter the Bindplane agent port number (for example, `514`).
   - **Protocol** : Select **TCP** or **UDP**, depending on your actual Bindplane agent configuration.
   - **Format** : Select **JSON**.
6. Configure the log fields to forward:
   - Click **Select Fields** or access the field selection configuration.
   - Select the relevant log fields according to your requirements. The following fields are commonly required for security analysis:
     - `TIMESTAMP` (Creation Time)
     - `LOG_ID` (Data Identifier)
     - `EVENT` (Event)
     - `EVENT_ID` (Event ID)
     - `SRC` (Source Address)
     - `DST` (Destination Address)
     - `Sport` (Source Port)
     - `Dport` (Destination Port)
     - `PROTOCOL` (Protocol)
     - `SERVICE` (Service)
     - `RULE_ID` (Rule Tag)
     - `ACTION` (Action)
     - `NAT_SRC`, `NAT_DST`, `NAT_SPORT`, `NAT_DPORT` (NAT fields)
     - `ACC_RX_BYTES`, `ACC_TX_BYTES`, `ACC_ELAPSED` (Accounting fields)
     - `NODE_ID` (Sender)
     - `COMP_ID` (Component ID)
     - `FACILITY` (Facility)
     - `INFO_MSG` (Information Message)
     - `SITUATION` (Situation)
     - `APPLICATION` (Application)
   - For a complete list of exportable fields, refer to the [Forcepoint NGFW Exportable Firewall and Layer 2 Firewall log entry fields](https://help.forcepoint.com/ngfw/en-us/7.0.1/GUID-106A79FF-BB78-4BB2-8957-16D17AF8A8A4.html) documentation.
7. Scroll down to the **Events** section and select the relevant log types or **all**.
8. Save the configuration.
9. Apply the changes to the Log Server.

   > [!NOTE]
   > **Note:** For optimal time correlation across systems, it is recommended to configure your Forcepoint NGFW to use UTC timezone. Timezone settings can be configured in the SMC system settings or log server profiles.

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| `AccElapsed` | `network.session_duration.seconds` | Directly mapped from `AccElapsed` if not empty or 0. Converted to integer. |
| `AccRxBytes` | `network.received_bytes` | Directly mapped from `AccRxBytes`. Converted to unsigned integer. |
| `AccTxBytes` | `network.sent_bytes` | Directly mapped from `AccTxBytes`. Converted to unsigned integer. |
| `Action` | `security_result.action_details` | Directly mapped from `Action`. |
| `Action` | `security_result.action` | If `Action` is "Allow", set to "ALLOW". If `Action` is "Discard", set to "BLOCK". |
| `CompId` | `target.hostname` | Directly mapped from `CompId`. |
| `Dport` | `target.port` | Directly mapped from `Dport` if not 0. Converted to integer. |
| `Dst` | `target.ip` | Directly mapped from `Dst`. |
| `Event` | `metadata.product_event_type` | Directly mapped from `Event`. |
| `Facility` | `metadata.description` | Directly mapped from `Facility`. |
| `InfoMsg` | `security_result.description` | Directly mapped from `InfoMsg`. |
| `LogId` | `metadata.product_log_id` | Directly mapped from `LogId`. |
| `NatDport` | `target.nat_port` | Directly mapped from `NatDport` if not 0. Converted to integer. |
| `NatDst` | `target.nat_ip` | Directly mapped from `NatDst`. |
| `NatSport` | `principal.nat_port` | Directly mapped from `NatSport` if not 0. Converted to integer. |
| `NatSrc` | `principal.nat_ip` | Directly mapped from `NatSrc`. |
| `NodeId` | `intermediary.ip` | Directly mapped from `NodeId` if both `Src` or `Dst` and `NodeId` are present. |
| `NodeId` | `principal.ip` | Directly mapped from `NodeId` if `NodeId` is present but `Src` and `Dst` are not. |
| `Protocol` | `network.ip_protocol` | Mapped from `Protocol` after converting it to an integer and then using a lookup to convert the number to the protocol name (e.g., 6 becomes TCP). |
| `RuleId` | `security_result.rule_id` | Directly mapped from `RuleId`. |
| `Service` | `principal.application` | Directly mapped from `Service` if it's not "Dest. Unreachable (Port Unreachable)". |
| `Service` | `network.application_protocol` | If `Service` is "HTTP" or "HTTPS", set to the value of `Service`. If `Service` contains "DNS", set to "DNS". |
| `Service` | `metadata.event_type` | If `Service` is "HTTP" or "HTTPS", set `metadata.event_type` to "NETWORK_HTTP". |
| `Situation` | `security_result.summary` | Directly mapped from `Situation`. |
| `Sport` | `principal.port` | Directly mapped from `Sport` if not 0. Converted to integer. |
| `Src` | `principal.ip` | Directly mapped from `Src`. |
| `Timestamp` | `metadata.event_timestamp` | Directly mapped from `Timestamp` after parsing it as a date. |
| `Type` | `security_result.severity_details` | Directly mapped from `Type`. |
| `Type` | `security_result.severity` | If `Type` is "Notification", set to "LOW". If `Src` or `NodeId` and `Dst` or `CompId` are present, set to "NETWORK_CONNECTION". If only `principal.ip` is present, set to "STATUS_UPDATE". Otherwise, set to "GENERIC_EVENT". Set to "FORCEPOINT_FIREWALL". Set to "FORCEPOINT FIREWALL". Set to "FORCEPOINT". |
| `rt` | `metadata.event_timestamp` | Directly mapped from `rt` after parsing it as a date in the CEF block. |
| `act` | `security_result.action_details` | Directly mapped from `act` in the CEF block. |
| `app` | `principal.application` | Directly mapped from `app` in the CEF block. |
| `deviceFacility` | `metadata.description` | Directly mapped from `deviceFacility` in the CEF block. |
| `destinationTranslatedAddress` | `target.nat_ip` | Directly mapped from `destinationTranslatedAddress` in the CEF block. |
| `destinationTranslatedPort` | `target.nat_port` | Directly mapped from `destinationTranslatedPort` in the CEF block. |
| `dst` | `target.ip` | Directly mapped from `dst` in the CEF block. |
| `dpt` | `target.port` | Directly mapped from `dpt` in the CEF block. |
| `dvchost` | `intermediary.ip` | Directly mapped from `dvchost` in the CEF block. |
| `event_name` | `metadata.product_event_type` | Directly mapped from `event_name` in the CEF block. |
| `msg` | `security_result.description` | Directly mapped from `msg` in the CEF block. |
| `proto` | `network.ip_protocol` | Mapped from `proto` after converting it to an integer and then using a lookup to convert the number to the protocol name (e.g., 6 becomes TCP) in the CEF block. |
| `sourceTranslatedAddress` | `principal.nat_ip` | Directly mapped from `sourceTranslatedAddress` in the CEF block. |
| `sourceTranslatedPort` | `principal.nat_port` | Directly mapped from `sourceTranslatedPort` in the CEF block. |
| `spt` | `principal.port` | Directly mapped from `spt` in the CEF block. |
| `src` | `principal.ip` | Directly mapped from `src` in the CEF block. |
| `NodeId` | `event.idm.read_only_udm.intermediary.ip` | Mapped from changelog |
| `CompId` | `event.idm.read_only_udm.intermediary.hostname` | Mapped from changelog |
| `eventid` | `metadata.product_log_id` | Mapped from changelog |

## Change Log

[View the Change Log for this parser](https://docs.cloud.google.com/chronicle/docs/ingestion/parser-list/forcepoint-firewall-changelog)

**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/)