Collect AlgoSec Security Management logs

Supported in:

Google secops SIEM

This document explains how to ingest AlgoSec Security Management logs to Google Security Operations using the Bindplane agent.

AlgoSec Security Management Suite (ASMS) provides network security policy management across firewalls, SDN, and cloud platforms. It includes Firewall Analyzer for risk and compliance analysis, FireFlow for change management automation, and AppViz for application connectivity visibility.

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 AlgoSec appliances
If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
Privileged access to AlgoSec Firewall Analyzer, FireFlow, and AppViz

Get Google SecOps ingestion authentication file

Sign in to the Google SecOps console.
Go to SIEM Settings > Collection Agents.
Download the Ingestion Authentication File.
Save the file securely on the system where the Bindplane agent will be installed.

Note: This JSON file contains credentials for authenticating the Bindplane agent to Google SecOps.

Get Google SecOps customer ID

Sign in to the Google SecOps console.
Go to SIEM Settings > Profile.
Copy and save the Customer ID from the Organization Details section.

Note: The customer ID is required for configuring the Bindplane agent exporter.

Install the Bindplane agent

Install the Bindplane agent on your Windows or Linux operating system according to the following instructions.

Windows installation

Open Command Prompt or PowerShell as an administrator.

Run the following command:

msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

Wait for the installation to complete.
Verify the installation by running:
```
sc query observiq-otel-collector
```
The service should show as RUNNING.

Linux installation

Open a terminal with root or sudo privileges.

Run the following command:

sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

Wait for the installation to complete.
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 nano /etc/bindplane-agent/config.yaml

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:
    udplog:
        listen_address: "0.0.0.0:514"

exporters:
    chronicle/algosec:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: ALGOSEC
        raw_log_field: body

service:
    pipelines:
        logs/algosec_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/algosec

Configuration parameters

Replace the following placeholders:

Receiver configuration:
- listen_address: IP address and port to listen on:
  - 0.0.0.0 to listen on all interfaces (recommended)
  - Port 514 is the standard syslog port (requires root on Linux; use 1514 for non-root)
Exporter configuration:
- creds_file_path: Full path to ingestion authentication file:
  - Linux: /etc/bindplane-agent/ingestion-auth.json
  - Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- customer_id: Customer ID copied from the Google SecOps console
- endpoint: 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

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, run the following command:

sudo systemctl restart observiq-otel-collector

Verify the service is running:

sudo systemctl status observiq-otel-collector

Check logs for errors:

sudo journalctl -u observiq-otel-collector -f

To restart the Bindplane agent in Windows, 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.
  4. Verify the service is running:
```
sc query observiq-otel-collector
```
  5. Check logs for errors:
```
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
```

Configure syslog for Firewall Analyzer

Sign in to the AFA appliance using SSH.
Go to the syslog-ng configuration directory:
```
cd /etc/syslog-ng
```
Backup the existing configuration:
```
cp syslog-ng.conf syslog-ng.conf.orig
```
Edit the syslog-ng configuration file:
```
vi syslog-ng.conf
```
Add the following lines to define the remote syslog server:
```
destination d_remote { udp("<BINDPLANE_IP>" port(514)); };
log { source(s_sys); destination(d_remote); };
```
- Replace <BINDPLANE_IP> with the IP address of the Bindplane agent.
Save and exit the editor.
Restart the syslog-ng service to apply changes:
```
service syslog-ng restart
```
Optional: Verify the Syslog configuration:
1. Go to Administration > Syslog Server Settings.
2. Click Test Connectivity.

Configure syslog for FireFlow

Sign in to the FireFlow machine as root.
Open the /etc/syslog.conf file for editing:
```
vi /etc/syslog.conf
```
Add the following line to the file:
```
local0.*@<BINDPLANE_IP>
```
- Replace <BINDPLANE_IP> with the IP address of the Bindplane agent server.

Configure Syslog for AppViz

Sign in to the AppViz appliance via SSH.
Go to the syslog-ng configuration directory:
```
cd /etc/syslog-ng
```
Back up the existing configuration:
```
cp syslog-ng.conf syslog-ng.conf.orig
```
Edit the syslog-ng configuration file:
```
vi syslog-ng.conf
```
Add the following to define the remote syslog server:
```
destination d_remote { udp("<BINDPLANE_IP>" port(514)); };
log { source(s_sys); destination(d_remote); };
```
- Replace <BINDPLANE_IP> with the IP address of the Bindplane agent.
Save and exit the editor.
Restart the syslog-ng service to apply changes:
```
service syslog-ng restart
```
Verify the syslog configuration:
1. In the AppViz interface, go to Administration > Syslog Server Settings.
2. Click Test Connectivity.

Configure syslog for login and logout events

Sign in to the ASMS appliance via SSH.
Go to the syslog-ng configuration directory:
```
cd /etc/syslog-ng
```
Backup the existing configuration:
```
cp syslog-ng.conf syslog-ng.conf.orig
```
Edit the syslog-ng configuration file:
```
vi syslog-ng.conf
```
Add the following to define the remote syslog server:
```
destination d_remote { udp("<BINDPLANE_IP>" port(514)); };
log { source(s_sys); destination(d_remote); };
```
- Replace <BINDPLANE_IP> with the IP address of the Bindplane agent.
Save and exit the editor.
Restart the syslog-ng service to apply changes:
```
service syslog-ng restart
```

UDM mapping table

Log Field	UDM Mapping	Logic
`by_user`	`principal.user.user_display_name`	The value of the `by_user` field from the raw log is assigned to this UDM field.
`collection_time`	`metadata.event_timestamp`	The seconds and nanos fields are combined to create a timestamp.
`comm`	`target.process.command_line`	The value of the `comm` field extracted from the `desc` field using grok is assigned to this UDM field.
`datetime`	`metadata.event_timestamp`	The date and time are extracted from the raw log and used to populate the event timestamp.
`desc`	`metadata.description`	The value of the `desc` field from the raw log is assigned to this UDM field when no other description is available.
`dest_ip`	`target.ip`	The value of the `dest_ip` field from the raw log is assigned to this UDM field.
`dest_port`	`target.port`	The value of the `dest_port` field from the raw log is assigned to this UDM field.
`details`	`security_result.summary`	The value of the `details` field from the raw log is assigned to this UDM field.
`device`	`principal.asset.hostname`	The value of the `device` field from the raw log is assigned to this UDM field.
`dst_ip`	`target.ip`	The value of the `dst_ip` field from the raw log is assigned to this UDM field.
`dst_port`	`target.port`	The value of the `dst_port` field from the raw log is assigned to this UDM field.
`event_id`	`metadata.product_event_type`	The value of the `event_id` field from the raw log is assigned to this UDM field. It is also used in parser logic to determine the `metadata.event_type` and other fields.
`event_name`	`metadata.product_event_type`	The value of the `event_name` field from the raw log is assigned to this UDM field.
`firewall`	`target.hostname`	The value of the `firewall` field from the raw log is assigned to this UDM field.
`host`	`principal.hostname`	The value of the `host` field from the raw log is assigned to this UDM field.
`host_type`	`principal.asset.category`	The value of the `host_type` field from the raw log is assigned to this UDM field.
`iporhost`	`principal.ip/principal.hostname/target.ip/target.hostname/observer.ip/observer.hostname`	If the value is an IP address, it's mapped to `principal.ip,target.ip,` or `observer.ip` depending on the log source and event type. If it's a hostname, it's mapped to `principal.hostname,target.hostname,` or `observer.hostname`.
`IP`	`principal.ip`	The value of the `IP` field from the raw log is assigned to this UDM field.
`kv_data`	`security_result.summary`	The value of the `kv_data` field from the raw log is assigned to this UDM field.
`log_type`	`metadata.log_type`	Hardcoded to `ALGOSEC`.
`metric`	`security_result.action_details`	The value of the `metric` field from the raw log is assigned to this UDM field.
`msg`	`security_result.summary/security_result.description`	The value of the `msg` field from the raw log is used to populate either the summary or description of the security result, depending on the context. It is also used to `extractrisk_level,risk_count,risk_code,` and `risk_title` fields.
`pid`	`target.process.pid`	The value of the `pid` field extracted from the `desc` field using grok is assigned to this UDM field.
`product`	`metadata.product_name`	The value of the `product` field from the raw log is assigned to this UDM field.
`report`	`security_result.description`	The value of the `report` field from the raw log is included in the description of the security result.
`report_data.Device IP`	`target.ip`	The value of the `Device IP` field from the parsed JSON data is assigned to this UDM field.
`report_data.Highest Risk Level`	`security_result.description`	The value of the `Highest Risk Level` field from the parsed JSON data is included in the description of the security result. It is also used to determine the severity of the security result.
`report_data.Security Rating Score`	`security_result.description`	The value of the `Security Rating Score` field from the parsed JSON data is included in the description of the security result.
`Requestor.Email`	`principal.user.email_addresses`	The value of the `Email` field within the `Request` object from the parsed JSON data is assigned to this UDM field.
`Requestor.Name`	`principal.user.user_display_name`	The value of the `Name` field within the `Requestor` object from the parsed JSON data is assigned to this UDM field.
`RequestType`	`target.resource.attribute.labels`	The value of the `RequestType` field from the raw log is added as a label to the target resource.
`risk_title`	`security_result.summary`	The value of the `risk_title` field from the raw log is assigned to this UDM field.
`src_ip`	`principal.ip`	The value of the `src_ip` field from the raw log is assigned to this UDM field.
`src_port`	`principal.port`	The value of the `src_port` field from the raw log is assigned to this UDM field.
`status`	`security_result.description/security_result.action_details`	The value of the `status` field from the raw log is included in the description of the security result or action details, depending on the context. It is also used to determine the severity of the security result.
`target_app`	`target.application`	The value of the `target_app` field from the raw log is assigned to this UDM field.
`TemplateName`	`metadata.description`	The value of the `TemplateName` field from the raw log is assigned to this UDM field.
`url`	`security_result.url_back_to_product`	The value of the `url` field from the raw log is assigned to this UDM field.
`user`	`principal.user.userid`	The value of the `user` field from the raw log is assigned to this UDM field.
`vendor`	`metadata.vendor_name`	The value of the `vendor` field from the raw log is assigned to this UDM field.
`version`	`metadata.product_version`	The value of the `version` field from the raw log is assigned to this UDM field.
`WorkFlow`	`target.resource.attribute.labels`	The value of the `WorkFlow` field from the raw log is added as a label to the target resource.
`(Parser Logic)`	`extensions.auth.type`	Hardcoded to `MACHINE`.
`(Parser Logic)`	`security_result.action`	Determined based on the `event_id` and other fields. Typically set to `ALLOW or BLOCK`.
`(Parser Logic)`	`security_result.category`	Hardcoded to `POLICY_VIOLATION` for Firewall Analyzer events.
`(Parser Logic)`	`security_result.description`	Constructed based on other fields, providing context and details about the event.
`(Parser Logic)`	`security_result.severity`	Determined based on the `event_id,msg,` and other fields. Typically set to `LOW,MEDIUM,` or `HIGH.
`(Parser Logic)`	`metadata.event_type`	Determined based on the `event_id` and other fields. Examples include `USER_LOGIN,USER_LOGOUT,USER_RESOURCE_ACCESS,GENERIC_EVENT,STATUS_UNCATEGORIZED,SCAN_HOST,NETWORK_CONNECTION,` and `STATUS_UPDATE`.

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