Collect Saiwall VPN logs

Supported in:

Google SecOps SIEM

This document explains how to ingest Saiwall VPN logs to Google Security Operations using the Bindplane agent.

Saiwall Secure SD-WAN, developed by SAIMA Systems, is an enterprise network security platform that combines firewall, proxy, VPN encryption, and LDAP services into a centralized management solution. The VPN component uses SSL VPN protocol over TCP with 2048-bit security certificates and AES 256-bit symmetric encryption, providing secure connectivity between remote sites and the central office across distributed enterprise environments.

Before you begin

Make sure you have the following prerequisites:

• A Google SecOps instance
• A Windows 2016 or later or Linux host with systemd
• If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
• Privileged access to the Saiwall Secure SD-WAN management console (SAIWALL SD-WAN Orchestrator)

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 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: 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 SIEM 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: 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 a 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, see the Bindplane agent installation guide.

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

1. Access the configuration file:

   • Locate the config.yaml file. Typically, it's in the /opt/observiq-otel-collector/ 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:
       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
       # 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: chronicle.googleapis.com
       # Add optional ingestion labels for better organization
       log_type: 'SAIWALL_VPN'
       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 <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.
   • Replace <PROJECT_NUMBER> with the project number from IAM & Admin > Settings.
   • Replace <customer_id> with the actual Customer ID.
   • Update /path/to/ingestion-authentication-file.json to the file path where the service account key file (Option 1) was saved in Step 1.

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 (for example, europe-malachiteingestion-pa.googleapis.com).

  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: 'SAIWALL_VPN'
      raw_log_field: body
      ingestion_labels:
  

Note: This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

Restart the Bindplane agent to apply the changes

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

  sudo systemctl restart observiq-otel-collector
  

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

  net stop observiq-otel-collector && net start observiq-otel-collector
  

Configure Saiwall syslog forwarding

To configure the Saiwall Secure SD-WAN appliance to forward syslog messages to the Bindplane agent, follow these steps:

1. Sign in to the SAIWALL SD-WAN Orchestrator web management console.
2. Go to Configuration > System > Logging.
3. In the Syslog section, click Enable to activate remote syslog forwarding.
4. Provide the following configuration details:
   • Syslog Server: Enter the IP address of the Bindplane agent host (for example, 192.168.1.100).
   • Port: Enter 514 (or the port configured in the Bindplane agent).
   • Protocol: Select UDP.
   • Facility: Select local0 or the appropriate facility for your environment.
5. In the Log Categories section, enable the following log types for forwarding:
   • VPN connection events (tunnel establishment and teardown)
   • Firewall traffic events (allow and deny)
   • Authentication events (user logins and logouts)
   • System events (configuration changes and alerts)
6. Click Save to apply the syslog configuration.

7. Click Synchronize to push the configuration to all connected SAIWALL SR devices.

   Note: If you are using the SAIWALL SIEM Connector module, logs from all SAIWALL SR devices connected to the infrastructure are centralized and forwarded through a single configuration, without requiring individual device setup.

For more information, see the SAIMA Systems documentation.

UDM mapping table

Log Field	UDM Mapping	Logic
egressInterface_label	additional.fields	Merged
flowEndMilliseconds_label	additional.fields	Merged
flowEndReason_label	additional.fields	Merged
flowStartMilliseconds_label	additional.fields	Merged
format_label	additional.fields	Merged
header_map_label	additional.fields	Merged
ingressInterface_label	additional.fields	Merged
ipClassOfService_label	additional.fields	Merged
ipNextHopIPv4Address_label	additional.fields	Merged
octetDeltaCount_label	additional.fields	Merged
packetDeltaCount_label	additional.fields	Merged
protocolIdentifier_label	additional.fields	Merged
tcpControlBits_label	additional.fields	Merged
inter_host	intermediary.hostname	Directly mapped
record.nexthop	intermediary.ip	Merged
port	intermediary.port	Renamed/mapped
event_type	metadata.event_type	Directly mapped
record.input	network.received_bytes	Renamed/mapped
record.output	network.sent_bytes	Renamed/mapped
record.srcaddr	principal.ip	Merged
sourceIPv4Address	principal.ip	Merged
record.srcport	principal.port	Renamed/mapped
sourceTransportPort	principal.port	Renamed/mapped
destinationIPv4Address	target.ip	Merged
record.dstaddr	target.ip	Merged
destinationTransportPort	target.port	Renamed/mapped
record.dstport	target.port	Renamed/mapped
record_map_label	target.resource.attribute.labels	Merged

Change Log

View the Change Log for this parser

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