Collect Yubico OTP logs

Supported in:

Google secops SIEM

This document explains how to ingest Yubico OTP logs to Google Security Operations using the Bindplane agent.

Yubico OTP is a hardware-based one-time password authentication protocol. The YubiKey Validation Server (ykval) is a self-hosted PHP application that validates OTP tokens and logs validation requests via syslog (LOG_LOCAL0 facility).

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 YubiKey Validation Server
If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
A self-hosted YubiKey Validation Server (ykval) with syslog output configured

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 Bindplane agent installation guide.

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

service:
    pipelines:
        logs/yubico_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/yubico_otp

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 ykval syslog forwarding

Verify that the ykval syslog output is configured. Add the following to /etc/rsyslog.d/ykval.conf (or the equivalent for your syslog daemon):
```
local0.*    @<BINDPLANE_AGENT_IP>:514
```
Note: Replace <BINDPLANE_AGENT_IP> with the IP address of the host running the Bindplane agent. Use @@ instead of @ for TCP instead of UDP.
Restart the rsyslog service:
```
sudo systemctl restart rsyslog
```
Verify that OTP validation requests are being forwarded by checking the Bindplane agent logs.

Note: The log format is configured using the YKVAL_VERIFY_LOGFORMAT parameter in the ykval configuration file (ykval-config.php).

UDM mapping table

Log Field	UDM Mapping	Logic
token1, token2, token3, token4	additional.fields	Merged from additional_token1 if token1 not empty, additional_token2 if token2 not empty, additional_token3 if token3 not empty, additional_token4 if token4 not empty
token1, token2	extensions.auth.mechanism	Set to "OTP" if token1 or token2 not empty
	extensions.auth.type	Set to "AUTHTYPE_UNSPECIFIED" if description matches authenticated, wrong, logged in
intermediary	intermediary	Merged
description	metadata.description	Value copied directly
description, audit_type, product_event, has_principal_machine_field, has_principal_user_id	metadata.event_type	Set to USER_LOGIN if description matches authenticated, wrong, logged in; else SYSTEM_AUDIT_LOG_UNCATEGORIZED if audit_type matches audit and has_principal_machine_field true and has_principal_user_id true; else STATUS_UPDATE if has_principal_machine_field true; else USER_UNCATEGORIZED if has_principal_user_id true; else GENERIC_EVENT
product_event	metadata.product_event_type	Value copied directly
observer	observer.hostname	Set if observer not IP
observer	observer.ip	Merged if observer is IP
principal	principal	Renamed
sdomain	principal.administrative_domain	Value copied directly
domain_name	principal.domain.name	Value copied directly
node	principal.hostname	Value copied directly
cwd, exe	principal.process.file.full_path	Set to cwd if not empty, else exe if not empty
ppid	principal.process.parent_process.pid	Value copied directly
pid	principal.process.pid	Value copied directly
uid, gid, euid, suid, fsuid, egid, sgid, fsgid, comm, subj, key, arch, name, ouid, ogid, inode, cap_fp, cap_fi, cap_fe, mode, proctitle	principal.resource.attribute.labels	Merged with corresponding labels if fields not empty
user	principal.user.email_addresses	Merged if user matches email pattern
user	principal.user.user_display_name	Set if user does not match email pattern
suser, user_id, auid	principal.user.userid	Set to suser if not empty, else user_id if user not empty and grok succeeds, else auid if not empty
security_result	security_result	Merged
description, status	security_result.action	Set to ALLOW if description matches success or logged in or status GRANTED, else BLOCK if description matches wrong
severity	security_result.severity	Set to LOW if severity matches (?i)(low\|Unknown\|info)
summary	security_result.summary	Value copied directly
target	target	Renamed
hostname, server, src_ip	target.hostname	Set to hostname if not empty, else server if not empty, else src_ip if not IP
src_ip	target.ip	Merged if src_ip is IP
product	metadata.product_name	Value copied directly
vendor	metadata.vendor_name	Value copied directly

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