Collect F5 ASM logs

This document explains how to ingest F5 Application Security Manager (ASM) logs to Google Security Operations using Bindplane. The parser handles various F5 ASM log formats (such as syslog, CSV, CEF, and Splunk), and normalizes them into the Unified Data Model (UDM). It uses grok patterns and key-value extractions to parse fields, XML filtering for violation details, conditional logic for event categorization and severity mapping, and merges extracted fields into the UDM schema.

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 F5 ASM

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

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: 'F5_ASM'
               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 Syslog in F5 ASM

1. Sign in to the tmsh instance by typing the following command:

   tmsh
   

2. Edit syslog configuration using the following command:

   edit /sys syslog all-properties
   

3. Syslog configuration opens in the vi text editor and appears similar to the following example:

   modify syslog {
             auth-priv-from notice
             auth-priv-to emerg
             cron-from warning
             cron-to emerg
             daemon-from notice
             daemon-to emerg
             description none
             include none
             iso-date disabled
             kern-from notice
             kern-to emerg
             mail-from notice
             mail-to emerg
             messages-from notice
             messages-to warning
             remote-servers none
             user-log-from notice
             user-log-to emerg
         }
   

4. Replace the include none line with the following syslog filter:

       include `
             filter f_audit{
                 match(AUDIT);
             };
             destination d_syslog_server {
                     udp(\`<bindplane-ip>\` port (<bindplane-port>));
             };
             log {
                     source(s_syslog_pipe);
                         filter(f_audit);
                         destination(d_syslog_server);
             };
             `
   

5. Replace <bindplane-ip> and <bindplane-port> with the actual IP address and port number configured for your Bindplane agent.

6. Exit vi by typing the following key sequence:

   :wq!
   

7. At the following prompt, type y to save the changes to the file:

   Save changes? (y/n/e)
   

8. Save the configuration by typing the following command:

   save /sys config
   

UDM mapping table

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