Collect ESET AV logs

Supported in:

Google secops SIEM

This document explains how to ingest ESET antivirus logs to Google Security Operations using the Bindplane agent.

ESET is an endpoint security solution that generates syslog messages for threat detections, firewall events, HIPS alerts, and audit actions. The parser extracts key-value pairs from JSON-formatted syslog and maps them to the Unified Data Model (UDM).

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 ESET PROTECT server
If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
Privileged access to ESET PROTECT console (on-premises or Cloud)

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 the 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/eset_av:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: ESET_AV
        raw_log_field: body

service:
    pipelines:
        logs/eset_av_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/eset_av

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 on ESET PROTECT on-premises

Sign in to the ESET PROTECT web console.
Click More > Settings > Advanced Settings > Syslog Server.
Toggle the Enable Syslog switch to enable syslog.
Provide the following configuration details:
- Host: Enter the Bindplane agent IP address.
- Port: Enter 514.
- Format: Select Syslog.
- Transport: Select UDP.
- Trace log verbosity: Select Informational.
- Export logs to Syslog: Set to Enable.
- Exported logs format: Select JSON.
Click Save.

Configure syslog on ESET PROTECT Cloud

Sign in to the ESET PROTECT Cloud console.
Click More > Settings > Syslog Server.
Toggle the Enable Syslog switch to enable syslog.
Provide the following configuration details:
- Format of payload: Select JSON.
- Format of envelope: Select Syslog.
- Minimum log Level: Select Informational.
- Event types to log: Select All (or specific types as needed).
- Destination IP: Enter the Bindplane agent IP address.
- Port: Enter 514.
Click Save.

UDM mapping table

Log Field	UDM Mapping	Logic
account	principal.administrative_domain	Extracted from the `account` field using grok pattern `%{DATA:admin_domain}\\\\%{WORD:user_id}`.
account	principal.user.userid	Extracted from the `account` field using grok pattern `%{DATA:admin_domain}\\\\%{WORD:user_id}`.
action	security_result.action	If `action` is `Block` (case-insensitive), set to `BLOCK`. If `action` is `Start` (case-insensitive), set to `ALLOW`.
action_taken	security_result.action_details	Directly mapped from the `action_taken` field.
computer_severity_score	security_result.detection_fields	A key-value pair is created with the key `computer_severity_score` and the value from the `computer_severity_score` field. This pair is appended to the `security_result.detection_fields` array.
detail	security_result.description	Directly mapped from the `detail` field.
domain	principal.domain.name	Directly mapped from the `domain` field.
eialarmid	security_result.detection_fields	A key-value pair is created with the key `eialarmid` and the value from the `eialarmid` field. This pair is appended to the `security_result.detection_fields` array.
eiconsolelink	principal.url	Directly mapped from the `eiconsolelink` field.
event	metadata.description	Renamed from `event` to `event_desc` and mapped to `metadata.description`.
event_type	metadata.product_event_type	Directly mapped from the `event_type` field.
group_name	principal.group.group_display_name	Directly mapped from the `group_name` field.
hash	principal.file.sha1	Converted to lowercase. If the lowercase value matches the SHA-1 regex, mapped to `principal.file.sha1`.
hash	principal.resource.attribute.labels	A key-value pair is created with the key `hash` and the value from the `hash` field. This pair is appended to the `principal.resource.attribute.labels` array.
hostname	principal.asset.hostname	Directly mapped from the `hostname` field.
hostname	principal.hostname	Directly mapped from the `hostname` field.
inbound	network.direction	If true, set to `INBOUND`. If false, set to `OUTBOUND`.
ipv4	target.asset.ip	Directly mapped from the `ipv4` field if `target_address` is empty.
ipv4	target.ip	Directly mapped from the `ipv4` field if `target_address` is empty.
json_data		Parsed as JSON to extract various fields.
message		Parsed using grok to extract timestamp, host, and json_data.
need_restart	additional.fields	A key-value pair is created with the key `need_restart` and the value from the `need_restart` field (converted to string). This pair is appended to the `additional.fields` array.
os_name	principal.platform	If contains `Window` or `window` (case-insensitive), set to `WINDOWS`. If contains `Linux` or `linux` (case-insensitive), set to `LINUX`. If contains `Mac` or `mac` (case-insensitive), set to `MAC`.
os_name	principal.platform_version	Directly mapped from the `os_name` field.
process_name	principal.process.file.full_path	Directly mapped from the `process_name` field. If empty, takes the value of `processname`.
processname	principal.process.file.full_path	If `process_name` is empty, mapped to `process_name`.
protocol	network.ip_protocol	Converted to uppercase. If the uppercase value matches known protocols (TCP, UDP, ICMP, etc.), mapped to `network.ip_protocol`.
result	security_result.summary	Directly mapped from the `result` field.
rulename	security_result.rule_name	Directly mapped from the `rulename` field.
scan_id	security_result.detection_fields	A key-value pair is created with the key `scan_id` and the value from the `scan_id` field. This pair is appended to the `security_result.detection_fields` array.
scanner_id	security_result.detection_fields	A key-value pair is created with the key `scanner_id` and the value from the `scanner_id` field. This pair is appended to the `security_result.detection_fields` array.
severity	security_result.severity	If contains `Warn` or `warn` (case-insensitive), set to `HIGH`. If contains `Info` or `info` (case-insensitive), set to `LOW`.
severity_score	security_result.detection_fields	A key-value pair is created with the key `severity_score` and the value from the `severity_score` field. This pair is appended to the `security_result.detection_fields` array.
source_address	principal.asset.ip	Directly mapped from the `source_address` field.
source_address	principal.ip	Directly mapped from the `source_address` field.
source_port	principal.port	Converted to string and then to integer. Mapped to `principal.port`.
source_uuid	metadata.product_log_id	Directly mapped from the `source_uuid` field.
target		Renamed to `target1`.
target_address	target.asset.ip	Directly mapped from the `target_address` field.
target_address	target.ip	Directly mapped from the `target_address` field.
target_port	target.port	Converted to string and then to integer. Mapped to `target.port`.
threat_handled	security_result.detection_fields	A key-value pair is created with the key `threat_handled` and the value from the `threat_handled` field (converted to string). This pair is appended to the `security_result.detection_fields` array.
threat_name	security_result.threat_name	Directly mapped from the `threat_name` field.
threat_type	security_result.threat_id	Directly mapped from the `threat_type` field.
time	metadata.event_timestamp	Used to populate `metadata.event_timestamp`.
username	principal.user.userid	Directly mapped from the `username` field if `user_id` and `user` are empty.
user	principal.user.userid	Directly mapped from the `user` field if `user_id` is empty.
	metadata.event_type	If `source_address` and `target_address` are not empty, set to `NETWORK_CONNECTION`. Else if `has_user` is true, set to `USER_UNCATEGORIZED`. Else if `has_principal` is true, set to `STATUS_UPDATE`. Otherwise, set to `GENERIC_EVENT`.
	metadata.log_type	Set to `ESET_AV`.
	metadata.product_name	Set to `ESET_AV`.
	metadata.vendor_name	Set to `ESET_AV`.
	intermediary.hostname	The value of this field is taken from the `host` field extracted from the log message.
	principal.user.userid	If the field `account` is not empty, the parser extracts the user ID from the `account` field using a grok pattern. Otherwise it checks if the field `user` is not empty, if so it takes its value. If both `account` and `user` are empty, it checks if the field `username` is not empty, if so it takes its value.

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