Collect Citrix StoreFront logs

This document explains how to ingest Citrix StoreFront logs to Google Security Operations using Bindplane. The parser extracts fields from Citrix StoreFront Windows Event Log formatted logs. It uses Windows Event Log collection 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. The parser extracts data from Citrix StoreFront JSON logs by breaking down the message field into individual entities like Session, User, AppInstance, App, Connection, and Machine using a series of grok patterns. It then maps the extracted fields to a unified data model (UDM) structure, enriching it with network, principal, intermediary, and target information based on conditional logic and data transformations.

Before you begin

Make sure you have the following prerequisites:

• A Google SecOps instance.
• A Windows 2016 or later host with systemd where Bindplane will be installed
• If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
• Privileged access to the Citrix StoreFront server and management console
• Administrative access to the Windows server hosting StoreFront

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

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
   

Additional installation resources

• For additional installation options, consult this installation guide.

Configure the Bindplane agent to ingest Windows event logs and send to Google SecOps

1. Access the configuration file:

   1. Locate the config.yaml file. Typically, it's in the /etc/bindplane-agent/ directory on Linux or in the installation directory on Windows.
   2. Open the file using a text editor (for example, nano, vi, or Notepad).

2. Edit the config.yaml file as follows:

   receivers:
     windowseventlog/storefront:
       channel: Application
       operators:
         - type: filter
           expr: 'record["source_name"] matches "^Citrix"'
   
   exporters:
     chronicle/chronicle_w_labels:
       compression: gzip
       # Adjust the path to the credentials file you downloaded in Step 1
       creds_file_path: 'C:/path/to/ingestion-authentication-file.json'
       # Replace with your actual customer ID from Step 2
       customer_id: CUSTOMER_ID_PLACEHOLDER
       endpoint: malachiteingestion-pa.googleapis.com
       # Add optional ingestion labels for better organization
       log_type: 'CITRIX_STOREFRONT'
       raw_log_field: body
       ingestion_labels:
   
   service:
     pipelines:
       logs/storefront:
         receivers:
           - windowseventlog/storefront
         exporters:
           - chronicle/chronicle_w_labels
   

   • Replace CUSTOMER_ID_PLACEHOLDER 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

1. 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 StoreFront event logging

1. Sign in to the StoreFront Server with administrative privileges.
2. Open PowerShell as an administrator.

3. Load the StoreFront PowerShell module:

   Add-PSSnapin Citrix.DeliveryServices.Framework.Commands
   

4. Enable verbose logging for troubleshooting (optional):

   Set-STFDiagnostics -All -TraceLevel "Info" -confirm:$False
   

5. Verify Windows Event Logging is enabled:

   • Open Event Viewer on the StoreFront server.
   • Navigate to Application and Services Logs > Citrix Delivery Services.
   • Verify that events are being logged for the authentication service, stores, and Receiver for Web sites.

Optional: Configure event log throttling

1. Navigate to the StoreFront configuration directories:
   • Authentication service: C:/inetpub/wwwroot/Citrix/Authentication
   • Store: C:/inetpub/wwwroot/Citrixstorename
   • Receiver for Web site: C:/inetpub/wwwroot/Citrixstorename/Web
2. Open the web.config file in each directory using a text editor.

3. Locate the logger element and configure as needed:

   <logger duplicateInterval="00:01:00" duplicateLimit="10">
   

4. duplicateInterval: Set the time period in hours, minutes, and seconds over which duplicate log entries are monitored.

5. duplicateLimit: Set the number of duplicate entries that must be logged within the specified time interval to trigger log throttling.

6. Save the configuration files.

Verify log collection

1. Open the Windows Event Viewer on the StoreFront server.
2. Navigate to Windows Logs > Application or Application and Services Logs > Citrix Delivery Services.
3. Verify that StoreFront events are being generated.
4. Check the Bindplane agent logs to confirm logs are being forwarded to Google SecOps.

UDM mapping table

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