Collect CrushFTP logs

Supported in:

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

CrushFTP is an enterprise file transfer server that generates syslog messages for file transfers, user authentication, and system events. The parser extracts fields and maps them to the Unified Data Model (UDM).

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 CrushFTP server
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • Privileged access to the CrushFTP web UI

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.
  4. Save the file securely on the system where the Bindplane agent 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 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
    
  3. Wait for the installation to complete.

  4. Verify the installation by running:

    sc query observiq-otel-collector
    

    The service should show as RUNNING.

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
    
  3. Wait for the installation to complete.

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

Configure the 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/crushftp:
            compression: gzip
            creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
            customer_id: '<customer_id>'
            endpoint: malachiteingestion-pa.googleapis.com
            log_type: CRUSHFTP
            raw_log_field: body
    
    service:
        pipelines:
            logs/crushftp_to_chronicle:
                receivers:
                    - udplog
                exporters:
                    - chronicle/crushftp
    

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
    
    1. Verify the service is running:

      sudo systemctl status observiq-otel-collector
      
    2. 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 CrushFTP syslog

  1. Sign in to the CrushFTP web UI.
  2. Go to Preferences > Logging > Syslog section.
  3. Provide the following configuration details:
    • Select the Enable checkbox.
    • Host: Enter the Bindplane agent IP address.
    • Port: Enter the Bindplane agent port number.
    • Protocol: Select UDP (or TCP, depending on your Bindplane configuration).
    • Logging Provider: Select SysLog.
  4. Click Save Settings.

UDM mapping table

Log Field UDM Mapping Logic
exists_label additional.fields Merged
msg metadata.description Directly mapped
timestamp metadata.event_timestamp Parsed as MM/dd/yyyy HH:mm:ss.SSS
has_principal metadata.event_type Mapped: trueNETWORK_CONNECTION, trueFILE_UNCATEGORIZED, trueSTATUS_UPDATE
prod_event_type metadata.product_event_type Directly mapped
http_method network.http.method Directly mapped
Response_code network.http.response_code Renamed/mapped
sessionid network.session_id Directly mapped
src_ip principal.asset.ip Merged
group principal.group.group_display_name Directly mapped
src_host principal.hostname Directly mapped
src_ip principal.ip Merged
src_port principal.port Renamed/mapped
email principal.user.email_addresses Mapped: ^.+@.+$email
owner principal.user.userid Directly mapped
Description security_result.description Directly mapped
http_version_label security_result.detection_fields Merged
domainname target.asset.hostname Directly mapped
target_ip target.asset.ip Merged
url target.file.full_path Directly mapped
name target.file.names Merged
size target.file.size Renamed/mapped
domainname target.hostname Directly mapped
target_ip target.ip Merged
target_port target.port Renamed/mapped
modified_label target.resource.attribute.labels Merged
permissions_label target.resource.attribute.labels Merged
privs_label target.resource.attribute.labels Merged
target_url target.url Directly mapped
N/A metadata.event_type Constant: GENERIC_EVENT
N/A metadata.product_name Constant: CrushFTP
N/A metadata.vendor_name Constant: CrushFTP

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