Collect WinSCP logs

Supported in:

Google SecOps SIEM

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

WinSCP is an open-source SFTP, SCP, and FTP client for Windows that generates file transfer, authentication, and session activity logs. The Bindplane agent collects WinSCP session log files directly from the local file system.

Before you begin

Make sure you have the following prerequisites:

• A Google SecOps instance
• Windows Server 2016 or later with observiq-otel-collector service support
• If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
• A Windows machine running WinSCP with logging enabled

Get Google SecOps credentials for the Bindplane agent

To authenticate the Bindplane agent to Google SecOps, choose one of the following methods:

• New deployments: Use the Chronicle API (Option 1).
• Legacy deployments: Continue using the ingestion authentication file (Option 2) until the Ingestion API is discontinued on July 20, 2027.

Option 1: Create a service account for the Chronicle API (recommended)

1. Sign in to the Google Cloud console and select the Google Cloud project that is linked to your Google SecOps instance.
2. Go to IAM & Admin > Service Accounts.
3. Click Create service account.
4. Provide the following configuration details:
   • Service account name: Enter a name for the account (for example, bindplane-ingest).
   • Service account description: Enter a description (for example, Bindplane agent log ingestion).
5. Click Create and continue.
6. In the Grant this service account access to project section, click Select a role and select Chronicle Editor.
7. Click Continue, and then click Done.
8. Click the service account you created, and then go to the Keys tab.
9. Click Add key > Create new key.
10. Select JSON and click Create. The key file is downloaded to your computer.
11. Save the key file as ingestion-auth.json in the Bindplane collector directory (/opt/observiq-otel-collector/ingestion-auth.json on Linux or C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json on Windows), or update creds_file_path in config.yaml to match the path where you save it.
12. Go to IAM & Admin > Settings and copy the Project number. You'll need it for the exporter configuration.

Note: The JSON key is a credential. Restrict access to the file on the Bindplane host and rotate the key according to your organization's policy.

Option 2: Download the ingestion authentication file (legacy)

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.

Note: This file authenticates the agent to the legacy Ingestion API (malachiteingestion-pa.googleapis.com), which Google has scheduled for end of life on July 20, 2027. Plan to move to Option 1 before that date.

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.

   Note: The customer ID is required for configuring the Bindplane agent exporter.

Install the Bindplane agent

Install the Bindplane agent on your Windows 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.

Additional installation resources

For additional installation options and troubleshooting, see Bindplane agent installation guide.

Note: The Chronicle API exporter configuration requires Bindplane collector v1.106.0 or later. The previous commands install the latest release. If you're updating an existing installation, upgrade the collector before changing the configuration.

Configure Bindplane agent to ingest logs and send to Google SecOps

Locate the configuration file

• 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:
    filelog:
      include:
        - C:\Logs\WinSCP\*.log
      start_at: beginning
  
  exporters:
    chronicle/winscp:
      protocol: https
      # Region of your instance, for example us, europe, asia-southeast1
      location: <LOCATION>
      # Project number of the Google Cloud project linked to the instance
      project: '<PROJECT_NUMBER>'
      compression: gzip
      creds_file_path: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: WINSCP
      raw_log_field: body
      ingestion_labels:
        env: production
  
  service:
    pipelines:
      logs/winscp_to_chronicle:
        receivers:
          - filelog
        exporters:
          - chronicle/winscp
  

Configuration parameters

Replace the following placeholders:

• Receiver configuration:

  • filelog: The receiver type for collecting log files from disk
  • include: List of file paths to monitor. Set this to the location where WinSCP writes session logs (for example, C:\Logs\WinSCP\*.log)
  • start_at: Set to beginning to read existing logs or end to only read new entries

• Exporter configuration:

  • winscp: Descriptive name for the exporter
  • creds_file_path: Full path to the service account JSON key file (Option 1):
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • <customer_id>: Customer ID from the previous step
  • location: Replace <LOCATION> with the region of your Google SecOps instance (for example, us, europe, or asia-southeast1). The exporter prefixes chronicle.googleapis.com with this value. See Regional Endpoints for the complete list.
  • project: Replace <PROJECT_NUMBER> with the project number from IAM & Admin > Settings.
  • endpoint: Keep set to chronicle.googleapis.com.
  • WINSCP: Log type exactly as it appears in Chronicle
  • ingestion_labels: Optional labels in YAML format (for example, env: production)

• Pipeline configuration:

  • winscp_to_chronicle: Descriptive name for the pipeline

Legacy ingestion API exporter

• If you use the ingestion authentication file from Option 2, replace the exporters block with the following. Set creds_file_path to the path to the ingestion authentication file, and if your instance is outside the US, replace malachiteingestion-pa.googleapis.com with your regional endpoint (for example, europe-malachiteingestion-pa.googleapis.com).

  exporters:
    chronicle/winscp:
      compression: gzip
      creds_file_path: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: WINSCP
      raw_log_field: body
      ingestion_labels:
        env: production
  

Note: This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

Save the configuration file

• After editing, save the file:
  • Windows: Click File > Save

Restart the Bindplane agent to apply the changes

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 WinSCP log export

WinSCP writes session logs to a user-configured location. You need to enable logging in WinSCP and point the Bindplane agent to the log directory.

1. Open WinSCP on the Windows machine.
2. Go to Options > Preferences > Logging.
3. Enable session logging:
   • Check Enable session logging on level.
   • Select Normal or Debug 1 logging level.
   • Set the Log file name to a centralized path (for example, C:\Logs\WinSCP\winscp.log).
4. Click OK to save the settings.

5. Create the log directory if it does not exist:

   mkdir C:\Logs\WinSCP
   

6. Verify that WinSCP writes log files to the configured directory after performing a file transfer session.

7. Ensure the Bindplane agent include path in config.yaml matches the log directory.

   Note: WinSCP generates XML session log files (.log extension) by default. If collecting logs from multiple users, you can use a wildcard path such as C:\Users\*\AppData\Roaming\WinSCP\*.log in the Bindplane agent configuration. The Bindplane agent service account must have read access to the log directory.

UDM mapping table

Log Field	UDM Mapping	Logic
directory,console,consoleinstance,public_key,script,hostkey,total_size	additional.fields	Additional custom fields for the event
description	metadata.description	Description of the event
timestamp	metadata.event_timestamp	Timestamp when the event occurred
	metadata.event_type	The type of the event
src_ip	principal.asset.ip	IP address of the asset associated with the principal
local_file	principal.file.full_path	Full path to the file associated with the principal
src_ip	principal.ip	IP address of the principal
command_line	principal.process.command_line	Command line used to launch the process
username	principal.user.userid	User ID of the principal
transfer_speed,result	security_result.detection_fields	Fields related to detection in the security result
file,target_file	target.file.full_path	Full path to the target file
file_type	target.file.mime_type	MIME type of the target file
file_size	target.file.size	Size of the target file in bytes
	metadata.product_name	Name of the product that generated the event
	metadata.vendor_name	Name of the vendor of the product

Change Log

View the Change Log for this parser

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