Collect Cisco eStreamer logs

This document explains how to ingest Cisco eStreamer logs to Google Security Operations using Bindplane. The parser extracts fields from the SYSLOG messages in key-value format, using grok to parse the initial message and kv to handle the key-value data. It then maps these extracted fields to the Unified Data Model (UDM), handling various data types and enriching the event with metadata like event type based on the presence of principal and target information.

Before you begin

Make sure you have the following prerequisites:

• A Google SecOps instance
• A Windows Server 2012 SP2 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

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

Get Google SecOps customer ID

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

Install Bindplane agent

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

Windows installation

1. Open the Command Prompt or PowerShell as an administrator.

2. Run the following command:

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

Linux installation

1. Open a terminal with root or sudo privileges.

2. 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 the installation guide.

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

1. Access the configuration file:
   • Locate the config.yaml file. Typically, it's in the /opt/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).

2. Edit the config.yaml file as follows:

   receivers:
     udplog:
       # Replace the port and IP address as required
       listen_address: "0.0.0.0:514"
   
   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 <customer_id> with the actual customer ID.
   • Update /path/to/ingestion-authentication-file.json to the path where the authentication file was saved in the Get Google SecOps ingestion authentication file section.

Restart the Bindplane agent to apply the changes

• To restart the Bindplane agent in Linux, run the following command:

  sudo systemctl restart bindplane-agent
  

• To restart the Bindplane agent in Windows, you can either use the Services console or enter the following command:

  net stop BindPlaneAgent && net start BindPlaneAgent
  

Configure Syslog forwarding on Cisco eStreamer

Configure eStreamer on Firepower Management Center

1. Sign in to the Firepower Management Center.
2. Go to System > Integration > eStreamer.
3. Click eStreamer to access the eStreamer Event Configuration.
4. 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
5. Click Save.

Create eStreamer Client

1. In the eStreamer page, click Create Client.
2. 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.
3. Click Save.
4. Download the generated PKCS12 certificate file and transfer it to your eNcore client system.

Install and Configure eNcore CLI Client

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

2. Extract the eNcore package:

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

3. Run the setup script:

   ./encore.sh setup
   

4. When prompted, choose the output format for key-value pairs (compatible with SIEM systems).

5. Enter the FMC IP address and the PKCS12 certificate password.

6. 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:514"
             }
           }
         ]
       }
     }
     

7. Replace BINDPLANE_AGENT_IP with the IP address of your Bindplane agent.

Start eNcore Client

1. Test the connection in foreground mode:

   ./encore.sh foreground
   

2. Once verified, start eNcore as a background service:

   ./encore.sh start
   

UDM Mapping Table

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