Collect ForgeRock OpenAM logs

This document explains how to ingest ForgeRock OpenAM logs to Google Security Operations using Bindplane. The parser extracts fields from the logs in CSV, Syslog + KV, or JSON formats, normalizes them, and maps them to the Unified Data Model (UDM). It handles various OpenAM event types, including login/logout, access outcomes, and general logs, enriching the data with user, group, and network information while also performing specific transformations for different log formats and event types. The parser prioritizes JSON parsing, then falls back to Syslog+KV, and finally CSV, dropping logs of unsupported formats.

Before you begin

Make sure you have the following prerequisites:

• Google SecOps instance
• Windows 2016 or later, or a Linux host with systemd
• If running behind a proxy, firewall ports are open
• Privileged access to Forgerock OpenAM (for example, amAdmin)

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 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, consult the installation guide.

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 /etc/bindplane-agent/ 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:
       udplog:
           # Replace the port and IP address as required
           listen_address: "0.0.0.0:514"
   
   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: <customer_id>
           endpoint: malachiteingestion-pa.googleapis.com
           # Add optional ingestion labels for better organization
           ingestion_labels:
               log_type: 'OPENAM'
               raw_log_field: body
   
   service:
       pipelines:
           logs/source0__chronicle_w_labels-0:
               receivers:
                   - udplog
               exporters:
                   - chronicle/chronicle_w_labels
   

3. Replace the port and IP address as required in your infrastructure.

4. Replace <customer_id> with the actual customer ID.

5. Update /path/to/ingestion-authentication-file.json to the path where the authentication file was saved in the Get Google SecOps ingestion authentication file section.

Restart the Bindplane agent to apply the changes

• To restart the Bindplane agent in Linux, run the following command:

  sudo systemctl restart bindplane-agent
  

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

  net stop BindPlaneAgent && net start BindPlaneAgent
  

Configure Audit Logging in Forgerock OpenAM

1. Sign in to the AM console.
2. Go to Configure > Global Services > Audit Logging.
3. Activate Audit logging to start the audit logging feature.
4. In the Field allowlist filters and Field blocklist filters lists, enter values to include (allowlist) or exclude (blocklist) from the audit event logs.
5. Click Save.

Configure Syslog Handlers for Forgerock OpenAM

1. Sign in to the AM console as an administrator, for example amAdmin.
2. To create the event handler in the global configuration, go to Configure > Global Services > Audit Logging.
3. To create the event handler in a realm, go to Realms > Realm Name > Services > Audit Logging.
4. Click Add a Secondary Configuration > Syslog.
5. Provide the following configuration details:
   • Name: Enter a name for the event handler (for example, Google SecOps Syslog Event Handler).
   • Server hostname: Enter the Bindplane agent IP address.
   • Server port: Enter the Bindplane agent port number (for example, 514 for UDP).
   • Transport Protocol: Select UDP.
   • Connection timeout: Enter the number of seconds to connect (for example, 120).
   • Optional: Enable the Buffering option.
6. Click Create.
7. After the syslog audit event handler is created, several configuration tabs appear.
8. On the General Handler Configuration tab, select Enabled to activate the event handler, if disabled.
9. Select the topics for audit logs:
   • Access
   • Activity
   • Authentication
   • Configuration
10. Click Save.
11. On the Syslog Configuration tab, provide the following configuration details:
    • Server hostname: Enter the Bindplane agent IP address.
    • Server port: Enter the Bindplane agent port number.
    • Connection timeout: Enter the number of seconds to connect (for example, 120).
    • Transport Protocol: Select UDP.
    • Facility: Select Local0.
    • All topics set the severity to INFORMATIONAL.
12. Click Save.

13. On the Buffering tab, select Buffering Enabled to activate it.

14. Click Save.

UDM mapping table

Need more help? Get answers from Community members and Google SecOps professionals.