Collect Veridium ID logs

Supported in:

Google secops SIEM

This document explains how to ingest Veridium ID logs to Google Security Operations using the Bindplane agent.

Veridium ID is a biometric authentication platform that generates syslog messages for authentication events, account management, device registration, and administrative actions. The parser extracts fields from syslog messages using grok patterns and key-value parsing, 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 Veridium ID host
If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
Privileged access to Veridium ID

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 Bindplane 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 /opt/observiq-otel-collector/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:
    tcplog:
        listen_address: "0.0.0.0:514"

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

service:
    pipelines:
        logs/veridium_id_to_chronicle:
            receivers:
                - tcplog
            exporters:
                - chronicle/veridium_id

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)
  - Veridium ID uses TCP (@@ in rsyslog), so tcplog receiver is required
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 Veridium ID

Sign in to the Veridium ID host using SSH or CLI.
Edit the /etc/rsyslog.conf or /etc/rsyslog.d/events.conf file:
```
vi /etc/rsyslog.conf
```

Add the following configuration, replacing <bindplane-ip> and <bindplane-port> with the actual Bindplane agent details:

module(load="imfile" PollingInterval="10")

input(type="imfile"
  File="/var/log/veridiumid/websecadmin/events.log"
  Tag="ver-adminevents"
  reopenOnTruncate="on")

input(type="imfile"
  File="/var/log/veridiumid/tomcat/events.log"
  Tag="ver-events"
  reopenOnTruncate="on")

if $programname == 'ver-events' then @@<bindplane-ip>:<bindplane-port>
if $programname == 'ver-adminevents' then @@<bindplane-ip>:<bindplane-port>

Save the file and exit.

UDM mapping table

Log Field	UDM Mapping	Logic
`_caller.accountId`	`principal.user.userid`	Directly mapped from the `_caller.accountId` field.
`_caller.accountEmailAddressInfo`	`principal.user.email_addresses`	Directly mapped from the `_caller.accountEmailAddressInfo` field.
`_caller.accountExternalId`	`principal.user.email_addresses`	Directly mapped from the `_caller.accountExternalId` field.
`_caller.accountStatus`	`principal.user.attribute.labels[account_status].value`	Directly mapped from the `_caller.accountStatus` field.
`_caller.deviceId`	`principal.asset.asset_id`	Prefixed with "VERIDIUM_ID:" and mapped from the `_caller.deviceId` field.
`_caller.deviceDescription`	`principal.asset.attribute.labels[device_description].value`	Directly mapped from the `_caller.deviceDescription` field.
`_caller.deviceManufacturer`	`principal.asset.attribute.labels[device_manufacturer].value`	Directly mapped from the `_caller.deviceManufacturer` field.
`_caller.deviceName`	`principal.asset.attribute.labels[device_name].value`	Directly mapped from the `_caller.deviceName` field.
`_caller.deviceOs`	`principal.asset.platform_software.platform`	Mapped from the `_caller.deviceOs` field. If the value is "iOS", it is mapped to "IOS". If the value is "Android", it is mapped to "ANDROID". If the value is "WIN" or "Windows", it is mapped to "WINDOWS".
`_caller.deviceStatus`	`principal.asset.attribute.labels[device_status].value`	Directly mapped from the `_caller.deviceStatus` field.
`_caller.deviceType`	`principal.asset.attribute.labels[device_type].value`	Directly mapped from the `_caller.deviceType` field.
`actionDate`	`additional.fields[action_date].value.string_value`	Directly mapped from the `actionDate` field.
`actionName`	`metadata.product_event_type`	Directly mapped from the `actionName` field.
`accountEmail`	`principal.user.email_addresses`	Directly mapped from the `accountEmail` field.
`accountExternalId`	`principal.user.email_addresses`	Directly mapped from the `accountExternalId` field.
`accountId`	`principal.user.userid`	Directly mapped from the `accountId` field.
`authenticatorDeviceContext.deviceMake`	`intermediary.asset.hardware.manufacturer`	Directly mapped from the `authenticatorDeviceContext.deviceMake` field.
`authenticatorDeviceContext.ip`	`intermediary.ip`	Directly mapped from the `authenticatorDeviceContext.ip` field.
`authenticatorDeviceContext.location.city`	`intermediary.asset.location.city`	Directly mapped from the `authenticatorDeviceContext.location.coordinates.latitude` field.
`authenticatorDeviceContext.location.coordinates.latitude`	`intermediary.asset.location.region_latitude`	Directly mapped from the `authenticatorDeviceContext.location.coordinates.latitude` field.
`authenticatorDeviceContext.location.coordinates.longitude`	`intermediary.asset.location.region_longitude`	Directly mapped from the `authenticatorDeviceContext.location.coordinates.longitude` field.
`authenticatorDeviceContext.location.countryName`	`intermediary.asset.location.country_or_region`	Directly mapped from the `authenticatorDeviceContext.location.countryName` field.
`authenticatorDeviceContext.location.ip`	`intermediary.ip`	Directly mapped from the `authenticatorDeviceContext.location.ip` field.
`authenticationDeviceDescription`	`intermediary.asset.attribute.labels[authentication_device_description].value`	Directly mapped from the `authenticationDeviceDescription` field.
`authenticationDeviceName`	`intermediary.asset.asset_id`	Prefixed with "VERIDIUM_ID:" and mapped from the `authenticationDeviceName` field.
`authenticationDeviceOs`	`intermediary.asset.platform_software.platform`	Mapped from the `authenticationDeviceOs` field. If the value is "iOS", it is mapped to "IOS". If the value is "Android", it is mapped to "ANDROID". If the value is "WIN" or "Windows", it is mapped to "WINDOWS".
`authenticationDeviceOsVersion`	`intermediary.asset.platform_software.platform_version`	Directly mapped from the `authenticationDeviceOsVersion` field.
`authenticationDevicePhone`	`intermediary.asset.attribute.labels[authentication_device_phone].value`	Directly mapped from the `authenticationDevicePhone` field.
`authenticationDevicePhoneModel`	`intermediary.asset.attribute.labels[authentication_device_phone_model].value`	Directly mapped from the `authenticationDevicePhoneModel` field.
`authenticationDeviceRegistrationTime`	`intermediary.asset.attribute.labels[authentication_device_registeration_time].value`	Directly mapped from the `authenticationDeviceRegistrationTime` field.
`authenticationDeviceType`	`intermediary.asset.attribute.labels[authentication_device_type].value`	Directly mapped from the `authenticationDeviceType` field.
`authenticationResult`	`extensions.auth.auth_details`	Directly mapped from the `authenticationResult` field.
`context.deviceMake`	`principal.asset.hardware.manufacturer`	Directly mapped from the `context.deviceMake` field.
`context.ip`	`principal.ip`	Directly mapped from the `context.ip` field.
`context.location.countryName`	`principal.location.country_or_region`	Directly mapped from the `context.location.countryName` field.
`context.location.ip`	`principal.ip`	Directly mapped from the `context.location.ip` field.
`context.osVersion`	`principal.asset.platform_software.platform_version`	Directly mapped from the `context.osVersion` field.
`context.userAgentRaw`	`network.http.user_agent`	Directly mapped from the `context.userAgentRaw` field.
`exploiterDeviceContext.deviceMake`	`src.asset.hardware.manufacturer`	Directly mapped from the `exploiterDeviceContext.deviceMake` field.
`exploiterDeviceContext.ip`	`src.ip`	Directly mapped from the `exploiterDeviceContext.ip` field.
`exploiterDeviceContext.location.city`	`src.asset.location.city`	Directly mapped from the `exploiterDeviceContext.location.city` field.
`exploiterDeviceContext.location.coordinates.latitude`	`src.asset.location.region_latitude`	Directly mapped from the `exploiterDeviceContext.location.coordinates.latitude` field.
`exploiterDeviceContext.location.coordinates.longitude`	`src.asset.location.region_longitude`	Directly mapped from the `exploiterDeviceContext.location.coordinates.longitude` field.
`exploiterDeviceContext.location.countryName`	`src.asset.location.country_or_region`	Directly mapped from the `exploiterDeviceContext.location.countryName` field.
`exploiterDeviceContext.location.ip`	`src.ip`	Directly mapped from the `exploiterDeviceContext.location.ip` field.
`exploiterDeviceContext.osName`	`src.asset.platform_software.platform`	Mapped from the `exploiterDeviceContext.osName` field. If the value is "WIN" or "Windows", it is mapped to "WINDOWS". If the value is "iOS", it is mapped to "IOS". If the value is "Android", it is mapped to "ANDROID".
`exploiterDeviceContext.osVersion`	`src.asset.platform_software.platform_version`	Directly mapped from the `exploiterDeviceContext.osVersion` field.
`exploiterDeviceName`	`src.asset.attribute.labels[exploiter_device_name].value`	Directly mapped from the `exploiterDeviceName` field.
`hostname`	`principal.hostname`	Directly mapped from the `hostname` field.
`ipAddress`	`principal.ip`	Directly mapped from the `ipAddress` field.
`location`	`principal.location.city`	Directly mapped from the `location` field.
`location.city`	`about.location.city`	Directly mapped from the `location.city` field.
`location.coordinates.latitude`	`about.location.region_latitude`	Directly mapped from the `location.coordinates.latitude` field.
`location.coordinates.longitude`	`about.location.region_longitude`	Directly mapped from the `location.coordinates.longitude` field.
`location.countryName`	`about.location.country_or_region`	Directly mapped from the `location.countryName` field.
`location.ip`	`about.ip`	Directly mapped from the `location.ip` field.
`metadata.collected_timestamp`	`metadata.collected_timestamp`	Directly mapped from the `collected_time` field.
`metadata.event_timestamp`	`metadata.event_timestamp`	Directly mapped from the `event_time` field.
`metadata.event_type`	`metadata.event_type`	Set to "USER_UNCATEGORIZED".
`metadata.product_event_type`	`metadata.product_event_type`	Directly mapped from the `actionName` field.
`metadata.product_name`	`metadata.product_name`	Set to "VERIDIUM_ID".
`namespace`	`principal.namespace`	Directly mapped from the `namespace` field.
`pid`	`principal.process.pid`	Directly mapped from the `pid` field.
`request.context.userAgentRaw`	`network.http.user_agent`	Directly mapped from the `request.context.userAgentRaw` field.
`request.sessionId`	`network.session_id`	Directly mapped from the `request.sessionId` field.
`requestMethod`	`network.http.method`	Directly mapped from the `requestMethod` field.
`requestURI`	`network.http.referral_url`	Directly mapped from the `requestURI` field.
`security_result.severity`	`security_result.severity`	Mapped from the `severity` field. If the value is "INFO", it is mapped to "INFORMATIONAL".
	`principal.application`	Directly mapped from the `application` field.
	`principal.asset.hostname`	Directly mapped from the `hostname` field.

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