Collect Yamaha router logs

This document explains how to ingest Yamaha router logs to Google Security Operations using Bindplane. The parser uses grok patterns to extract fields like timestamp, hostname, user, description, source and destination IP addresses from the syslog messages. It then maps these extracted fields to the UDM, categorizing the event type based on the presence of principal, target, and user information.

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, ensure firewall ports are open
• Privileged access to the Yamaha router appliance

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
           log_type: 'YAMAHA_ROUTER'
           raw_log_field: body
           ingestion_labels:
   
   service:
       pipelines:
           logs/source0__chronicle_w_labels-0:
               receivers:
                   - udplog
               exporters:
                   - chronicle/chronicle_w_labels
   

   • Replace the port and IP address as required in your infrastructure.
   • Replace <customer_id> with the actual customer ID.
   • 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 for the Yamaha router

1. Connect to the router using SSH or CLI.

2. Set Syslog Host to the Bindplane agent IP:

   • Default port is 514/UDP.
   • Replace <BINDPLANE_IP> with the actual Bindplane agent IP address.

   syslog host <BINDPLANE_IP>
   

3. Optional: Set Syslog facility and level:

   syslog facility local0
   syslog info
   

4. Save the configuration to ensure the changes persist after reboot:

   save
   

Enable Syslog output for the required modules

1. Enable logging for specific features:

   • Firewall (IP filter) logging:

     ip filter log on
     

   • NAT logging:

     • Where 1000 is the NAT descriptor number you're using (adjust as needed).

     nat descriptor log on 1000
     

   • PPPoE / WAN connection logging:

     pppoe use log on
     

   • If you use DHCP WAN (instead of PPPoE), log DHCP events:

     dhcp service log on
     

   • For IPsec VPN logging:

     ipsec log on
     

   • For L2TP and PPTP:

     l2tp log on
     pptp log on
     

   • Log interface up/down events:

     log state on
     

   • You can also enable logging for ping keepalive if you're using link monitoring:

     ping keepalive log on
     

   • Enable logging for administrative access (such as SSH or Telnet):

     console notice
     ssh notice
     telnet notice
     

   • Log DHCP assignments:

     dhcp service log on
     

   • DNS logging (if using built-in DNS forwarder):

     dns service log on
     

   • Mail transfer logging (if using email alerts):

     smtp service log on
     

   • Dynamic DNS logging:

     ddns service log on
     

   • NTP events:

     ntpdate log on
     

   • Authentication logging:

     auth log on
     

   • Radius logging:

     ppp use radius log on
     

2. Save configuration to ensure changes persist after reboot:

   save
   

UDM Mapping Table

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