Collect Symantec VIP Enterprise Gateway logs

Supported in:

This document explains how to ingest Symantec VIP Enterprise Gateway logs to Google Security Operations using Bindplane. The parser code first attempts to process the input log message as a JSON object. If this fails, it assumes a syslog format and uses regular expressions (grok patterns) to extract relevant fields like timestamps, IP addresses, usernames, and event descriptions. Finally, it maps the extracted information to the Unified Data Model (UDM) fields for standardized security event representation.

Before you begin

Ensure that you have the following prerequisites:

  • Google SecOps instance
  • Windows 2016 or later or Linux host with systemd
  • If running behind a proxy, firewall ports are open
  • Privileged access to Symantec VIP Enterprise Gateway

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 the Bindplane agent

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 /etc/bindplane-agent/ directory on Linux or in the installation 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: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: <customer_id>
        endpoint: malachiteingestion-pa.googleapis.com
        # Add optional ingestion labels for better organization
        ingestion_labels:
            log_type: 'SYMANTEC_VIP'
            raw_log_field: body

service:
    pipelines:
        logs/source0__chronicle_w_labels-0:
            receivers:
                - udplog
            exporters:
                - chronicle/chronicle_w_labels

  3. Replace the port and IP address as required in your infrastructure.

  4. Replace <customer_id> with the actual customer ID.

  5. 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 in Symantec VIP Enterprise Gateway

  1. Sign in to your Symantec VIP Gateway web UI.
  2. Go to Logs > Syslog Configuration.
  3. If you are configuring Syslog for the first time, you are prompted to configure the Syslog settings. Select Yes.
  4. If you have already configured Syslog, click Edit at the bottom of the page.
  5. Provide the following configuration details:
    • Syslog Facility: Select LOG_LOCAL0.
    • Syslog Host: Enter the Bindplane agent IP address.
    • Syslog Port: Enter the Bindplane agent port number (for example, 514 for UDP).
  6. Click Save.
  7. Go to Settings > Console Settings.
  8. Provide the following configuration details:
    • Logging Level: Select Info.
    • Enable Syslog: Select Yes.
  9. Click Submit.
  10. Go to Settings > Health Check Settings.
  11. Select Yes to enable the Health Check Service.
  12. Provide the following configuration details:
    • Logging Level: Select Info.
    • Enable Syslog: Select Yes.
  13. Click Submit.
  14. Go to User Store > LDAP Directory Synchronization.
  15. Edit the following configuration details:
    • Log Level: Select Info.
    • Enable Syslog: Select Yes.
  16. Click Submit.

UDM mapping table

Log field UDM mapping Logic
application read_only_udm.principal.application Value taken from application field extracted by json filter.
command read_only_udm.target.process.command_line Value taken from command field extracted by grok pattern.
credentialType This field is not directly mapped to the UDM. It is used to derive the value of read_only_udm.extensions.auth.mechanism.
data This field is not directly mapped to the UDM. It is parsed to extract other fields.
data2 This field is not directly mapped to the UDM. It is parsed to extract other fields.
datetime read_only_udm.metadata.event_timestamp.seconds
read_only_udm.metadata.event_timestamp.nanos		 Seconds and nanoseconds since epoch extracted from the datetime field.
desc read_only_udm.metadata.description Value taken from desc field extracted by json filter.
description read_only_udm.security_result.description Value taken from description field extracted by json filter.
filename read_only_udm.target.process.file.full_path Value taken from filename field extracted by grok pattern.
hostname read_only_udm.principal.hostname Value taken from hostname field extracted by json filter.
host_name read_only_udm.intermediary.hostname Value taken from host_name field extracted by json filter.
log_level This field is not directly mapped to the UDM. It is used to derive the value of read_only_udm.security_result.severity.
log_type read_only_udm.metadata.product_event_type Value taken from log_type field extracted by json filter.
msg This field is not directly mapped to the UDM. It is parsed to extract other fields.
operation read_only_udm.security_result.summary Value taken from operation field extracted by grok pattern.
processid read_only_udm.target.process.pid Value taken from processid field extracted by grok pattern.
product read_only_udm.metadata.product_name Value taken from product field extracted by json filter.
reason read_only_udm.metadata.description Value taken from reason field extracted by grok pattern.
request_id read_only_udm.target.resource.id Value taken from request_id field extracted by grok pattern.
src_ip read_only_udm.principal.ip Value taken from src_ip field extracted by grok pattern.
status read_only_udm.metadata.description Value taken from status field extracted by grok pattern.
summary read_only_udm.security_result.summary Value taken from summary field extracted by json filter.
timestamp.nanos read_only_udm.metadata.event_timestamp.nanos Nanoseconds from the original log timestamp.
timestamp.seconds read_only_udm.metadata.event_timestamp.seconds Seconds from the original log timestamp.
time This field is not directly mapped to the UDM. It is used to derive the values of read_only_udm.metadata.event_timestamp.seconds and read_only_udm.metadata.event_timestamp.nanos.
user read_only_udm.target.user.userid Value taken from user field extracted by json filter or grok pattern.
vendor read_only_udm.metadata.vendor_name Value taken from vendor field extracted by json filter.
read_only_udm.extensions.auth.mechanism Determined by the credentialType field. If credentialType is SMS_OTP or STANDARD_OTP, then OTP is used. If credentialType matches the regular expression PASSWORD, then USERNAME_PASSWORD is used.
read_only_udm.extensions.auth.type If the reason field matches the regular expression LDAP, then SSO is used. Otherwise, AUTHTYPE_UNSPECIFIED is used.
read_only_udm.metadata.event_type Determined by the presence of certain fields. If user or processid is not empty, then USER_LOGIN is used. If user is empty and src_ip is not empty or 0.0.0.0, then STATUS_UPDATE is used. Otherwise, GENERIC_EVENT is used.
read_only_udm.metadata.log_type Hardcoded to SYMANTEC_VIP.
read_only_udm.security_result.action Determined by the status field. If status is Authentication Success, GRANTED, Authentication Completed, After Services Authenticate call, or CHALLENGED, then ALLOW is used. If status is DENIED, Acces-Reject, Unknown Error, Service Unavailable, or FAILED, then BLOCK is used. If status is PUSH request sent for user or Trying to fetch attribute, then QUARANTINE is used.
read_only_udm.security_result.severity Determined by the log_level field. If log_level is DEBUG, INFO, or AUDIT, then INFORMATIONAL is used. If log_level is ERROR, then ERROR is used. If log_level is WARNING, then MEDIUM is used.

Changes

2023-03-03

Enhancement:

  • Mapped userid to target.user.userid for the logs that were not parsed already.
  • Mapped event_type to USER_LOGIN for the logs where userid is present, else if principal.hostname is present then mapped event_type to STATUS_UPDATE, else mapped it to GENERIC_EVENT.
  • Parsed the logs that were dropped initially.

2022-08-03

Bug fix:

  • Added the grok pattern to handle the unparsed logs having log_type remove_credentials.

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