# Collect ForgeRock OpenDJ logs

**Parser Version:** 2.0
Supported in:

This document explains how to ingest ForgeRock OpenDJ logs to Google Security Operations using Bindplane.

ForgeRock OpenDJ is an open-source LDAP directory server that provides identity data storage and authentication services. It generates access logs, audit logs, and error logs for LDAP operations, authentication events, and directory modifications. The parser extracts fields from OpenDJ log entries and maps them to the Unified Data Model (UDM).

## 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 ForgeRock OpenDJ server
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to the ForgeRock OpenDJ server with administrator permissions

## 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 the 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:
        tcplog:
          listen_address: "0.0.0.0:514"

      exporters:
        chronicle/opendj:
          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: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: '<customer_id>'
          endpoint: chronicle.googleapis.com
          log_type: OPENDJ
          raw_log_field: body

      service:
        pipelines:
          logs/opendj:
            receivers:
              - tcplog
            exporters:
              - chronicle/opendj

### Configuration parameters

Replace the following placeholders:

- **Receiver configuration:**

  - `tcplog`: The receiver type based on protocol:
    - `udplog` for UDP syslog
    - `tcplog` for TCP syslog
    - `syslog` for RFC 3164/5424 syslog
  - `0.0.0.0`: IP address to listen on:
    - `0.0.0.0` to listen on all interfaces (recommended)
    - Specific IP address to listen on one interface
  - `514`: Port number to listen on (for example, `514`, `1514`, `6514`)
- **Exporter configuration:**

  - `<customer_id>`: Customer ID from the earlier step
  - `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`.
  - Adjust the `creds_file_path` to the path of your service account JSON key file (Option 1), depending on the platform:
    - **Linux** : `/opt/observiq-otel-collector/ingestion-auth.json`
    - **Windows** : `C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json`

### 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/opendj:
          compression: gzip
          creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: '<customer_id>'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: OPENDJ
          raw_log_field: body

> [!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:

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:

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 ForgeRock OpenDJ syslog forwarding

ForgeRock OpenDJ stores logs locally on the server. Configure syslog forwarding using the system syslog daemon to send these logs to the Bindplane agent.

1. Identify the OpenDJ log directory. The default location is:

       /path/to/opendj/logs/

   - Key log files include `access`, `audit`, and `errors`.
2. Configure the system syslog daemon (for example, `rsyslog`) to monitor and forward OpenDJ log files. Create a new rsyslog configuration file:

       sudo nano /etc/rsyslog.d/opendj-forward.conf

3. Add the following content:

       module(load="imfile")
       input(type="imfile"
           File="/path/to/opendj/logs/access"
           Tag="opendj"
           Severity="info"
           Facility="local0")
       input(type="imfile"
           File="/path/to/opendj/logs/errors"
           Tag="opendj"
           Severity="error"
           Facility="local0")
       local0.* @@BINDPLANE_AGENT_IP:514

   > [!NOTE]
   > **Note:** Replace `/path/to/opendj/logs/` with the actual path to your OpenDJ log directory. Replace `BINDPLANE_AGENT_IP` with the IP address of the Bindplane agent host. Use `@@` for TCP or `@` for UDP.

4. Restart the rsyslog service:

       sudo systemctl restart rsyslog

## UDM field mapping reference

| Log Field | UDM Mapping | Logic |
|---|---|---|
| interim_server | intermediary.hostname | Hostname of the intermediary device |
|   | metadata.event_type | Type of event (for example, USER_LOGIN, NETWORK_CONNECTION) |
| kv_fields.request.operation | metadata.product_event_type | Product-specific event type |
|   | network.application_protocol | Application protocol used (for example, HTTP, LDAP) |
| application | principal.application | Name of the application associated with the principal |
| kv_fields.client.ip | principal.ip | IP address of the principal |
| kv_fields.client.port | principal.port | Port number of the principal |
|   | security_result.action | Action taken by the security system (for example, ALLOW, BLOCK) |
| kv_fields.request.filter | security_result.description | Description of the security result |
| kv_fields.server.ip | target.ip | IP address of the target |
| kv_fields.server.port | target.port | Port number of the target |
| kv_fields.request.dn | target.resource.name | Name of the resource |
|   | target.resource.type | Type of the resource |

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