收集 Citrix Receiver 日志

解析器版本： 1.0

支持：

本文档介绍了如何使用 Bindplane 代理将 Citrix Receiver 日志注入 Google Security Operations。

Citrix Receiver（现为 Citrix Workspace 应用）是一种客户端应用，可从 Citrix Virtual Apps and Desktops 环境访问虚拟桌面、应用和数据。日志会捕获会话事件、身份验证和客户端活动。

准备工作

请确保满足以下前提条件：

  • Google SecOps 实例
  • Windows Server 2016 或更高版本，或者具有 systemd 的 Linux 主机
  • Bindplane 代理与 Citrix Receiver 主机之间的网络连接
  • 如果通过代理运行，请确保防火墙端口根据 Bindplane 代理要求处于打开状态
  • 具有管理员权限的 Citrix 环境的特权访问权限
  • 对服务器或客户端文件系统上的 Citrix Receiver 日志文件的访问权限

获取 Bindplane 代理的 Google SecOps 凭据

如需对 Bindplane 代理进行 Google SecOps 身份验证，请选择以下方法之一：

  • 新部署：使用 Chronicle API（方法 1）。
  • 旧版部署：继续使用注入身份验证文件（方法 2），直到注入 API 于 2027 年 7 月 20 日停用为止。
  1. 登录 Google Cloud 控制台，然后选择与您的 Google SecOps 实例关联的 Google Cloud 项目。
  2. 依次前往 IAM 和管理 > 服务账号。
  3. 点击创建服务账号 。
  4. 提供以下配置详细信息：
    • 服务账号名称：输入账号的名称（例如 bindplane-ingest）。
    • 服务账号说明：输入说明（例如 Bindplane agent log ingestion）。
  5. 点击创建并继续 。
  6. 在向此服务帐号授予对项目的访问权限 部分，点击选择角色 ，然后选择 Chronicle Editor 。
  7. 点击继续 ，然后点击完成 。
  8. 点击您创建的服务帐号，然后前往密钥 标签页。
  9. 依次点击添加密钥 > 创建新密钥。
  10. 选择 JSON ，然后点击创建 。密钥文件会下载到您的计算机上。
  11. 将密钥文件另存为 Bindplane 收集器目录中的 ingestion-auth.json（在 Linux 上为 /opt/observiq-otel-collector/ingestion-auth.json，在 Windows 上为 C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json），或者更新 creds_file_path 在 config.yaml 中以与您保存该文件的路径匹配。
  12. 依次前往 IAM 和管理 > 设置 ，然后复制项目编号 。您需要此编号进行导出器配置。

方法 2：下载注入身份验证文件（旧版）

  1. 登录 Google SecOps 控制台。
  2. 依次前往 SIEM 设置 > 收集代理。
  3. 下载注入身份验证文件 。
  4. 将该文件安全地保存在将安装 Bindplane 代理的系统上。

获取 Google SecOps 客户 ID

  1. 登录 Google SecOps 控制台。
  2. 依次前往 SIEM 设置 > 个人资料。

  3. 从组织详细信息 部分复制并保存客户 ID 。

安装 Bindplane 代理

按照以下说明在 Windows 或 Linux 操作系统上安装 Bindplane 代理。

Windows 安装

  1. 以管理员身份打开命令提示符 或 PowerShell 。

  2. 运行以下命令：

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

  3. 等待安装完成。

  4. 运行以下命令，验证安装是否成功：

    sc query observiq-otel-collector

    该服务应显示为正在运行 。

Linux 安装

  1. 使用 root 或 sudo 权限打开终端。

  2. 运行以下命令：

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

  3. 等待安装完成。

  4. 运行以下命令，验证安装是否成功：

    sudo systemctl status observiq-otel-collector

    该服务应显示为活跃 (正在运行) 。

其他安装资源

如需了解其他安装选项和问题排查信息，请参阅 Bindplane 代理安装指南。

配置 Bindplane 代理以注入日志并发送到 Google SecOps

找到配置文件

  • Linux：

    sudo nano /opt/observiq-otel-collector/config.yaml

  • Windows：

    notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"

修改配置文件

  • 将 config.yaml 的全部内容替换为以下配置：

    receivers:
  filelog:
    include:
      - 'C:\Users\*\AppData\Local\Citrix\Receiver\*.log'
    start_at: beginning
    poll_interval: 5s

exporters:
  chronicle/citrix_rx:
    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: CSG_CITRIX_RX
    raw_log_field: body
    ingestion_labels:
      env: production

service:
  pipelines:
    logs/citrix_rx_to_chronicle:
      receivers:
        - filelog
      exporters:
        - chronicle/citrix_rx

配置参数

替换以下占位符：

  • 接收器配置：

    • include：Citrix Receiver 日志文件的路径：
      • Windows：C:\Users\*\AppData\Local\Citrix\Receiver\*.log
      • 集中式收集：如果日志收集到中央共享，请调整路径
    • start_at：设置为 beginning 以读取现有日志，或设置为 end 以仅读取新条目
    • poll_interval：检查新日志数据的频率（默认值：5s）

  • 导出器配置：

    • citrix_rx：导出器的描述性名称
    • creds_file_path：服务帐号 JSON 密钥文件的完整路径（方法 1）：
      • Linux: /opt/observiq-otel-collector/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • <customer_id>：上一步中的客户 ID
    • location：将 <LOCATION> 替换为 Google SecOps 实例的区域（例如 us、europe 或 asia-southeast1）。导出器会使用此值为 chronicle.googleapis.com 添加前缀。如需查看完整列表，请参阅区域级端点。
    • project：将 <PROJECT_NUMBER> 替换为 IAM 和管理 > 设置 中的项目编号。
    • endpoint：保持设置为 chronicle.googleapis.com。
    • CSG_CITRIX_RX：日志类型，与在 Chronicle 中显示的内容完全一致
    • ingestion_labels：YAML 格式的可选标签（例如 env: production）

  • 流水线配置：

    • citrix_rx_to_chronicle：流水线的描述性名称

旧版注入 API 导出器

  • 如果您使用方法 2 中的注入身份验证文件，请将 exporters 代码块替换为以下内容。将 creds_file_path 设置为注入身份验证文件的路径，并且如果您的实例位于美国境外，请将 malachiteingestion-pa.googleapis.com 替换为您的 区域级端点（例如 europe-malachiteingestion-pa.googleapis.com）。

    exporters:
  chronicle/citrix_rx:
    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: CSG_CITRIX_RX
    raw_log_field: body
    ingestion_labels:
      env: production

保存配置文件

  • 修改后，保存文件：
    • Linux：按 Ctrl+O，然后按 Enter，再按 Ctrl+X
    • Windows：依次点击文件 > 保存

重启 Bindplane 代理以应用更改

  • 如需在 Linux 中重启 Bindplane 代理，请运行以下命令：

    sudo systemctl restart observiq-otel-collector

    1. 验证服务是否正在运行：

      sudo systemctl status observiq-otel-collector

    2. 检查日志中的错误：

      sudo journalctl -u observiq-otel-collector -f

  • 如需在 Windows 中重启 Bindplane 代理，请选择以下选项之一：

    • 以管理员身份运行命令提示符或 PowerShell：

      net stop observiq-otel-collector && net start observiq-otel-collector

    • 服务控制台：

      1. 按 Win+R，输入 services.msc，然后按 Enter 键。
      2. 找到 observIQ OpenTelemetry Collector 。
      3. 右键点击并选择重启 。

      4. 验证服务是否正在运行：

        sc query observiq-otel-collector

      5. 检查日志中的错误：

        type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"

启用 Citrix Receiver 日志记录并配置日志收集

Citrix Receiver 中默认停用日志记录。您必须使用注册表条目启用日志记录，然后才能生成日志文件。

在 Windows 上启用日志记录

  1. 在 Citrix Receiver 客户端机器上以管理员身份打开注册表编辑器 (regedit)。
  2. 导航到 HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\Receiver。
  3. 创建一个名为 EnableTracing 的新字符串值 ，并将其设置为 true。

  4. 创建一个名为 TracePath 的新字符串值 ，以指定日志输出路径。例如：

    • C:\CitrixLogs\
    • 或者，使用默认路径：%USERPROFILE%\AppData\Local\Citrix\Receiver\

  5. 重启 Citrix Receiver 应用以使更改生效。

验证日志文件生成

  1. 启用日志记录后，打开 Citrix Receiver 并连接到已发布资源。
  2. 导航到日志目录：
    • 默认路径: %USERPROFILE%\AppData\Local\Citrix\Receiver\
    • 自定义路径：TracePath 注册表值中指定的路径。
  3. 验证是否正在创建 .log 文件，并且这些文件是否包含会话事件数据。

  4. 确保 Bindplane 代理对日志目录和文件具有读取权限。

UDM 映射表

日志字段 UDM 映射 逻辑
creationTime metadata.event_timestamp 解析为 dd/M/yyyy HH:mm:ss
timestamp metadata.event_timestamp 解析为 MMM d HH:mm:ss
has_principal metadata.event_type 映射：true → NETWORK_CONNECTION
has_user metadata.event_type 映射：true → USER_UNCATEGORIZED
logId metadata.product_log_id 直接映射
srcip principal.asset.ip 已合并
srcip principal.ip 已合并
userId principal.user.userid 直接映射
application target.application 直接映射
targetip target.asset.ip 已合并
targetip target.ip 已合并
resourcename target.resource.name 直接映射
不适用 metadata.event_type 常量：NETWORK_CONNECTION
不适用 metadata.product_name 常量：CSG Citrix RX
不适用 metadata.vendor_name 常量：CSG Citrix RX
logId event.idm.read_only_udm.metadata.product_log_id 从变更日志映射
application event.idm.read_only_udm.target.application 从变更日志映射
resourcename event.idm.read_only_udm.target.resource.name 从变更日志映射
srcip event.idm.read_only_udm.principal.ip 从变更日志映射
target event.idm.read_only_udm.principal.asset.ip 从变更日志映射
creationTime event.idm.read_only_udm.target.resource.attribute.creation_time 从变更日志映射
user event.idm.read_only_udm.principal.user.user 从变更日志映射
targetip event.idm.read_only_udm.target.ip 从变更日志映射
timestamp event.idm.read_only_udm.metadata.timestamp 从变更日志映射

更新日志

查看此解析器的更新日志

需要更多帮助？获得社区成员和 Google SecOps 专业人士的解答。