Collect Cisco eStreamer logs

Supported in:

Google secops SIEM

This document explains how you can ingest Cisco eStreamer logs to Google Security Operations using Bindplane.
The parser extracts fields from Cisco eStreamer syslog formatted logs with key-value pairs. It uses grok and/or kv to parse the log message and then maps these values to the Unified Data Model (UDM). It also sets default metadata values for the event source and type.

Before you begin

Make sure you have the following prerequisites:

A Google SecOps instance.
Windows Server 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 Cisco Firepower Management Center (FMC).
A Linux system to run the eNcore CLI client.

Get Google SecOps ingestion authentication file

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

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.

Install the Bindplane agent

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

Windows installation

Open the 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

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

Additional installation resources

For additional installation options, consult this installation guide.

Configure the Bindplane agent to ingest Syslog and send to Google SecOps

Access the Configuration File:
- Locate the config.yaml file. Typically, it's in the /observiq-otel-collector/ directory on Linux or `C:\Program Files\observIQ OpenTelemetry Collector` directory on Windows.
- Open the file using a text editor (for example, nano, vi, or Notepad).

Edit the config.yaml file as follows:

receivers:
  udplog:
    # Replace the port and IP address as required
    listen_address: "0.0.0.0:5514"

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: YOUR_CUSTOMER_ID
    endpoint: malachiteingestion-pa.googleapis.com
    # Add optional ingestion labels for better organization
    log_type: 'CISCO_ESTREAMER'
    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 YOUR_CUSTOMER_ID with the actual Customer ID.
Update /path/to/ingestion-authentication-file.json to the file path where the authentication file was saved in Step 1.

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.
Verify the service is running:
```
sc query observiq-otel-collector
```

Check logs for errors:

type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"

Configure Syslog forwarding on Cisco eStreamer

Configure eStreamer on Firepower Management Center

Sign in to the Firepower Management Center.
Go to System > Integration > eStreamer.
Click eStreamer to access the eStreamer Event Configuration.
Select the check boxes next to the types of events you want to capture:
- Intrusion Events: For intrusion detection events
- Intrusion Event Packet Data: For packet captures associated with intrusion events
- Connection Events: For network connection data
- Security Intelligence Events: For threat intelligence data
- File Events: For file analysis events
- Malware Events: For malware detection events
Click Save.

Create eStreamer Client

In the eStreamer page, click Create Client.
Provide the following configuration details:
- Hostname: Enter the IP address of the Linux system where eNcore client will run.
- Password: Enter a password to encrypt the certificate file.
Click Save.
Download the generated PKCS12 certificate file and transfer it to your eNcore client system.

Install and Configure eNcore CLI Client

On your Linux system, download the eStreamer eNcore CLI client from Cisco.

Extract the eNcore package:

tar -xzf eStreamer-eNcore-*.tar.gz
cd eStreamer-eNcore-*

Run the setup script:
```
./encore.sh setup
```
When prompted, choose the output format for key-value pairs (compatible with SIEM systems).
Enter the FMC IP address and the PKCS12 certificate password.

Configure the estreamer.conf file to output syslog messages to your Bindplane agent:

Open the estreamer.conf file in a text editor.
Locate the outputters section and configure it to send syslog to your Bindplane agent:

{
  "handler": {
    "outputters": [
      {
        "name": "syslog",
        "adapter": "kvpair",
        "enabled": true,
        "stream": {
          "uri": "udp://BINDPLANE_AGENT_IP:5514"
        }
      }
    ]
  }
}

Replace BINDPLANE_AGENT_IP with the IP address of your Bindplane agent.

Start eNcore Client

Test the connection in foreground mode:
```
./encore.sh foreground
```
Once verified, start eNcore as a background service:
```
./encore.sh start
```

UDM mapping table

Log Field	UDM Mapping	Logic
`additional_deviceInboundInterface`	`additional.fields`	Merged
`additional_deviceOutboundInterface`	`additional.fields`	Merged
`additional_start`	`additional.fields`	Merged
`has_target`	`extensions.auth.type`	Mapped: `true` → `AUTHTYPE_UNSPECIFIED`
`dvchost`	`intermediary.asset.hostname`	Directly mapped
`hostname`	`intermediary.asset.hostname`	Directly mapped
`dvchost`	`intermediary.hostname`	Directly mapped
`hostname`	`intermediary.hostname`	Directly mapped
`dvcpid`	`intermediary.process.pid`	Directly mapped
`ts`	`metadata.event_timestamp`	Parsed as `MMM d HH:mm:ss`
`has_principal`	`metadata.event_type`	Mapped values (5 total, e.g. `true` → `NETWORK_HTTP`, `true` → `NETWORK_DNS`, `true` → `NETW...
`has_target`	`metadata.event_type`	Mapped: `true` → `USER_UNCATEGORIZED`
`product_event_type`	`metadata.product_event_type`	Directly mapped
`product_name`	`metadata.product_name`	Directly mapped
`version`	`metadata.product_version`	Directly mapped
`vendor_name`	`metadata.vendor_name`	Directly mapped
`app`	`network.application_protocol`	Directly mapped
`src`	`network.dhcp.ciaddr`	Directly mapped
`deviceDirection`	`network.direction`	Mapped: `0` → `INBOUND`, `1` → `OUTBOUND`
`dns_question`	`network.dns.questions`	Merged
`requestClientApplication`	`network.http.user_agent`	Directly mapped
`ip_protocol_out`	`network.ip_protocol`	Directly mapped
`bytesIn`	`network.received_bytes`	Directly mapped
`bytesOut`	`network.sent_bytes`	Directly mapped
`deviceExternalId`	`principal.asset.asset_id`	Directly mapped
`src`	`principal.asset.ip`	Merged
`src`	`principal.ip`	Merged
`spt`	`principal.port`	Directly mapped
`security_result_action`	`security_result.action`	Merged
`act`	`security_result.action_details`	Directly mapped
`category`	`security_result.category`	Merged
`cat`	`security_result.category_details`	Merged
`cs5`	`security_result.description`	Directly mapped
`blockLength_label`	`security_result.detection_fields`	Merged
`blockType_label`	`security_result.detection_fields`	Merged
`cs1_var`	`security_result.detection_fields`	Merged
`cs2_var`	`security_result.detection_fields`	Merged
`cs3_var`	`security_result.detection_fields`	Merged
`cs4_var`	`security_result.detection_fields`	Merged
`cs5_var`	`security_result.detection_fields`	Merged
`cs6_var`	`security_result.detection_fields`	Merged
`suser_var`	`security_result.detection_fields`	Merged
`cs6`	`security_result.rule_id`	Directly mapped
`severity`	`security_result.severity_details`	Directly mapped
`outcome`	`security_result.summary`	Directly mapped
`destinationDnsDomain`	`target.asset.hostname`	Directly mapped
`dst`	`target.asset.ip`	Merged
`fname`	`target.file.full_path`	Directly mapped
`fileType`	`target.file.mime_type`	Directly mapped
`fileHash`	`target.file.sha256`	Directly mapped
`fsize`	`target.file.size`	Directly mapped
`destinationDnsDomain`	`target.hostname`	Directly mapped
`host`	`target.hostname`	Directly mapped
`dst`	`target.ip`	Merged
`dpt`	`target.port`	Directly mapped
`request`	`target.url`	Directly mapped
N/A	`extensions.auth.type`	Constant: `AUTHTYPE_UNSPECIFIED`
N/A	`metadata.event_type`	Constant: `NETWORK_HTTP`
N/A	`network.direction`	Constant: `INBOUND`
`BLOCK`	`security_result.action`	Mapped from changelog
`SOFTWARE_PUA`	`security_result.category`	Mapped from changelog
`NETWORK_COMMAND_AND_CONTROL`	`security_result.category`	Mapped from changelog
`TOR_EXIT_NODE`	`security_result.category`	Mapped from changelog
`PHISHING`	`security_result.category`	Mapped from changelog
`NETWORK_MALICIOUS`	`security_result.category`	Mapped from changelog
`request`	`network.http.referral_url`	Mapped from changelog
`destinationDnsDomain`	`network.dns.questions.name`	Mapped from changelog
`security_result.action`	`BLOCK`	Mapped from changelog

Change Log

View the Change Log for this parser

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