# Collect iBoss Web Proxy logs

Supported in:

This document explains how to ingest iBoss Web Proxy logs into Google Security Operations using Bindplane.

iBoss is a cloud-native Zero Trust Secure Access Service Edge (SASE) platform that provides secure internet access, Secure Web Gateway (SWG), CASB, ZTNA, and DLP capabilities. It routes traffic through its cloud infrastructure to enforce consistent security policies and threat protection for users regardless of location.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance
- Windows Server 2016 or later, or Linux host with `systemd`
- Network connectivity between the Bindplane agent and the iBoss cloud platform
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Administrator access to the iBoss portal with permissions to configure the **Integration Marketplace**

## 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.

> [!NOTE]
> **Note:** The customer ID is required for configuring the Bindplane agent exporter.

## Install the Bindplane agent

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

### Windows installation

1. Open **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

3. Wait for the installation to complete.

4. Verify the installation by running:

       sc query observiq-otel-collector

   The service should show as **RUNNING**.

### 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

3. Wait for the installation to complete.

4. Verify the installation by running:

       sudo systemctl status observiq-otel-collector

   The service should show as **active (running)**.

### Additional installation resources

For additional installation options and troubleshooting, see [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 Bindplane agent to ingest syslog and send to Google SecOps

### Locate the configuration file

- **Linux:**

      sudo nano /opt/observiq-otel-collector/config.yaml

- **Windows:**

      notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"

### Edit the configuration file

- Replace the entire contents of `config.yaml` with the following configuration:

      receivers:
        udplog:
          listen_address: "0.0.0.0:514"

      exporters:
        chronicle/iboss_webproxy:
          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
          creds_file_path: '<CREDS_FILE_PATH>'
          customer_id: '<CUSTOMER_ID>'
          endpoint: chronicle.googleapis.com
          log_type: IBOSS_WEBPROXY
          raw_log_field: body
          ingestion_labels:
            log_source: iboss

      service:
        pipelines:
          logs/iboss_to_chronicle:
            receivers:
              - udplog
            exporters:
              - chronicle/iboss_webproxy

### Configuration parameters

Replace the following placeholders:

- **Receiver configuration:**

  - `listen_address`: The IP address and port the Bindplane agent listens on for incoming syslog messages. Use `0.0.0.0` to listen on all interfaces. The port must match the port configured in the iBoss syslog forwarding settings.
  - If iBoss is configured to send logs over TCP, replace the `udplog` receiver with `tcplog`:

      receivers:
        tcplog:
          listen_address: "0.0.0.0:514"

  > [!NOTE]
  > **Note:** Update the receiver reference in the `service.pipelines` section accordingly.

- **Exporter configuration:**

  - `<CREDS_FILE_PATH>`: Full path to the service account JSON key file (Option 1):
    - **Linux** : `/opt/observiq-otel-collector/ingestion-auth.json`
    - **Windows** : `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json`
  - `<CUSTOMER_ID>`: Google SecOps customer ID copied earlier.
  - `location`: 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. See [Regional Endpoints](https://docs.cloud.google.com/chronicle/docs/reference/rest?rep_location=us#regional-service-endpoint) for the complete list.
  - `project`: Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.
  - `endpoint`: Keep set to `chronicle.googleapis.com`.

### 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/iboss_webproxy:
          compression: gzip
          creds_file_path: '<CREDS_FILE_PATH>'
          customer_id: '<CUSTOMER_ID>'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: IBOSS_WEBPROXY
          raw_log_field: body
          ingestion_labels:
            log_source: iboss

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

### Save the configuration file

After editing, save the file:

- **Linux** : Press `Ctrl+O`, then `Enter`, then `Ctrl+X`
- **Windows** : Click **File \> Save**

## Restart the Bindplane agent to apply the changes

To restart the Bindplane agent in Linux, do the following:

1. Run the following command:

       sudo systemctl restart observiq-otel-collector

2. Verify the service is running:

       sudo systemctl status observiq-otel-collector

3. Check logs for errors:

       sudo journalctl -u observiq-otel-collector -f

To restart the Bindplane agent in Windows, do the following:

1. Choose one of the following options:

   - Command Prompt or PowerShell as administrator:

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

   - Services console:

     1. Press `Win+R`, type `services.msc`, and press Enter.
     2. Locate **observIQ OpenTelemetry Collector**.
     3. Right-click and select **Restart**.
2. Verify the service is running:

       sc query observiq-otel-collector

3. Check logs for errors:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"

## Configure iBoss syslog forwarding

1. Sign in to the **iBoss** portal.
2. Go to **Integration Marketplace** , then select **Log Forwarding** from the left-hand menu and click the **Configure** button associated with the **Syslog Log Forwarding** widget.
3. Click the **Add Integration** button to add the Syslog integration.
4. Provide the following configuration details:

   - **Forward From** : Select **Reporter** from the dropdown.
   - **Select Reporting Database**: Select the Reporting Database.
   - **Service Name** : Enter a descriptive name for the integration (for example, `SecOps-Bindplane`).
   - **Enable Service** : Set this to **Enabled**.
   - **Log Type** : Select **URL** from the dropdown. This captures web proxy traffic logs (HTTP/HTTPS requests). To forward other event categories such as DLP or DNS, configure separate integrations with the corresponding log type.
   - **Protocol Type** : Select **UDP** or **TCP** from the dropdown.

     > [!NOTE]
     > **Note:** The protocol must match the receiver type configured in the Bindplane agent `config.yaml` file (`udplog` for UDP, `tcplog` for TCP). TCP is recommended for production environments as it provides reliable, ordered delivery.

   - **Syslog Facility Level** : Select **Facility Syslog** from the dropdown.

   - **Reporting Group** : Select **All** from the dropdown.

   - **Host Name**: Enter the IP address or fully qualified domain name of the Bindplane agent host.

   - **Port** : Enter the port number matching the `listen_address` port in the Bindplane agent configuration (for example, `514`).

     > [!NOTE]
     > **Note:** On Linux, port 514 is a privileged port. If the Bindplane agent runs as a non-root user, use a non-privileged port (for example, `5514`) and update both the iBoss **Port** field and the Bindplane `listen_address` to match.

   - **Log Format** : Select **JSON** from the dropdown.

   - **Transfer Interval** : Select **Continuous** from the dropdown.

   - **Field Delimiter** : Select **SPACE** from the dropdown.

   - **Send DLP/Web/DNS/Malware/Audit/ConnectionError Logs** : Set to **Enable** based on your preference for sending logs.

     > [!NOTE]
     > **Note:** The **Send Connection Error Logs** toggle is only visible in the iBoss UI when **Send Web Logs** is disabled.

   - **Fields to Forward** : Add all fields except **DLP Base64 Encoded Meta Data** , **Base64 Encoded Meta Data** , and **Chat GPT Message**.

5. Click **Add Service**.

> [!NOTE]
> **Note:** If you have multiple reporter nodes, repeat steps 3 and 4 for each reporter node.

## UDM mapping table

| Log field | UDM mapping | Logic |
|---|---|---|
| intermediary | intermediary | Information about an intermediary device or service involved in the event. |
| desc | metadata.description | Additional description of the event. |
| metadata.event_type | metadata.event_type | Type of event (e.g., USER_LOGIN, NETWORK_CONNECTION). |
| urlLogId | metadata.product_log_id | Unique identifier for the log entry from the product. |
| requestMethod | network.http.method | HTTP method used in the request. |
| ref_url | network.http.referral_url | URL that referred the user to the current page. |
| response_Code | network.http.response_code | HTTP response code. |
| user_Agent | network.http.user_agent | User agent string from the HTTP request. |
| up_stream | network.received_bytes | Number of bytes received in the network connection. |
| down_stream | network.sent_bytes | Number of bytes sent in the network connection. |
| computerName | principal.asset.hostname | Hostname of the asset associated with the principal. |
| computer_Mac_Address | principal.asset.mac | MAC address of the asset associated with the principal. |
| filtering_Group_Name | principal.group.group_display_name | Display name of the group associated with the principal. |
| computerName | principal.hostname | Hostname of the principal. |
| sourceIpAddress | principal.ip | IP address of the principal. |
| pri_ip | principal.ip |   |
| pub_ip | principal.ip |   |
| mac_address | principal.mac | MAC address of the principal. |
| src_port | principal.port | Port number used by the principal. |
| file_name | principal.process.file.names | Names of files associated with the process. |
| username | principal.user.userid | User ID of the principal. |
| sec_res | security_result | Result of security analysis, including actions and categories. |
| host | target.hostname | Hostname of the target. |
| ipAddress | target.ip | IP address of the target. |
| targetPort | target.port | Port number of the target. |
| uri_path | target.process.file.full_path | Full path of the file or resource on the target. |
| url | target.url | URL of the target. |
| metadata.product_name | metadata.product_name | Name of the product that generated the event. |
| metadata.vendor_name | metadata.vendor_name | Name of the vendor that produced the product. |

## Change Log

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

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