Collect ForgeRock OpenDJ logs

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 ingestion authentication file

  1. Sign in to the Google SecOps console.
  2. Go to SIEM Settings > Collection Agents.

  3. Download the Ingestion Authentication File. Save the file securely on the system where Bindplane will be installed.

Get Google SecOps customer ID

  1. Sign in to the Google SecOps console.
  2. Go to SIEM 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 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.

Configure the Bindplane agent to ingest syslog and send to Google SecOps

Locate the configuration file

  • Linux:

    sudo systemctl status observiq-otel-collector

  • 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:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.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
    • malachiteingestion-pa.googleapis.com: Regional endpoint URL:
      • US: malachiteingestion-pa.googleapis.com
      • Europe: europe-malachiteingestion-pa.googleapis.com
      • Asia: asia-southeast1-malachiteingestion-pa.googleapis.com
      • See Regional Endpoints for complete list
    • Adjust the creds_file_path depending on the platform:
      • Linux: /etc/bindplane-agent/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json

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

  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.