收集 Brocade ServerIron ADX 日志

解析器版本:2.0

支持范围:

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

Brocade ServerIron ADX 是一款应用交付控制器,可生成用于身份验证、负载均衡、网络事件和系统活动的 syslog 消息。解析器使用 grok 模式提取字段,并将其映射到统一数据模型 (UDM)。

准备工作

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

  • Google SecOps 实例
  • Windows Server 2016 或更高版本,或者安装了 systemd 的 Linux 主机
  • Bindplane 代理与 Brocade ServerIron ADX 设备之间的网络连接
  • 如果在代理后面运行,请确保按照 Bindplane 代理要求打开防火墙端口
  • 对 Brocade ServerIron ADX CLI 的管理员权限

获取 Bindplane 代理的 Google SecOps 凭证

如需向 Google SecOps 验证 Bindplane 代理,请选择以下方法之一:

  • 新部署:使用 Chronicle API(选项 1)。
  • 旧版部署:继续使用数据注入身份验证文件(方法 2),直到 Ingestion 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 收集器目录(Linux 上的 /opt/observiq-otel-collector/ingestion-auth.json 或 Windows 上的 C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json)中的 ingestion-auth.json,或更新 config.yaml 中的 creds_file_path 以匹配您保存它的路径。
  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
    

    该服务应显示为 active (running)。

其他安装资源

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

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

找到配置文件

  • Linux:

    sudo nano /opt/observiq-otel-collector/config.yaml
    
  • Windows:

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

修改配置文件

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

    receivers:
      udplog:
        listen_address: "0.0.0.0:514"
    
    exporters:
      chronicle/brocade_serveriron:
        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: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: chronicle.googleapis.com
        log_type: BROCADE_SERVERIRON
        raw_log_field: body
    
    service:
      pipelines:
        logs/brocade_serveriron_to_chronicle:
          receivers:
            - udplog
          exporters:
            - chronicle/brocade_serveriron
    

配置参数

替换以下占位符:

  • 接收器配置:

    • listen_address:要监听的 IP 地址和端口:
      • 0.0.0.0,以监听所有接口(推荐)
      • 端口 514 是标准 syslog 端口(在 Linux 上需要 root 权限;对于非 root 用户,请使用 1514)
  • 导出器配置:

    • 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:从 Google SecOps 控制台复制的客户 ID
    • location:将 <LOCATION> 替换为 Google SecOps 实例所在的区域(例如 us、europe 或 asia-southeast1)。导出工具会在此值前面加上 chronicle.googleapis.com。如需查看完整列表,请参阅区域级端点。
    • project:将 <PROJECT_NUMBER> 替换为 IAM 和管理 > 设置中的项目编号。
    • endpoint:保持设置为 chronicle.googleapis.com。

旧版提取 API 导出工具

  • 如果您使用选项 2 中的数据注入身份验证文件,请将 exporters 代码块替换为以下内容。将 creds_file_path 设置为数据注入身份验证文件的路径,如果您的实例位于美国境外,请将 malachiteingestion-pa.googleapis.com 替换为您的区域端点(例如 europe-malachiteingestion-pa.googleapis.com)。

    exporters:
      chronicle/brocade_serveriron:
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: BROCADE_SERVERIRON
        raw_log_field: body
    

保存配置文件

  • 修改后,保存文件:
    • Linux:依次按 Ctrl+O、Enter 和 Ctrl+X
    • Windows:依次点击文件 > 保存

重启 Bindplane 代理以应用更改

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

    sudo systemctl restart observiq-otel-collector
    
    1. 验证服务是否正在运行:

      ```bash
      sudo systemctl status observiq-otel-collector
      ```
      
    2. 检查日志中的错误:

      ```bash
      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 收集器。
      3. 右键点击并选择重启。
      4. 验证服务是否正在运行:

        sc query observiq-otel-collector
        
      5. 检查日志中的错误:

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

配置从 Brocade ServerIron ADX 导出 syslog

  1. 登录 ADX 设备并进入全局配置模式:

    enable
    configure terminal
    
  2. 启用 syslog 日志记录:

    logging on
    
  3. 指定 syslog 服务器 (Bindplane) 的 IP 地址和端口:

    logging host <syslog-server-ip> udp port 514
    
  4. 可选:设置 syslog 设施(local0 到 local7):

    logging facility local0
    
  5. 定义要发送到 syslog 服务器的日志的最低严重级别:

    logging trap <severity-level>
    
  6. 保存配置:

    write memory
    

UDM 映射表

日志字段 UDM 映射 逻辑
%{GREEDYDATA} metadata.description 当 %{GREEDYDATA} 字段与“-- %{GREEDYDATA} --”模式匹配时,该字段会映射到 metadata.description。
%{GREEDYDATA:auth_result} security_result.description 当 %{GREEDYDATA:desc} 存在时,%{GREEDYDATA:auth_result} 字段会与 %{GREEDYDATA:desc} 字段串联,以形成 security_result.description。
%{GREEDYDATA:desc} security_result.description %{GREEDYDATA:desc} 字段用于填充 security_result.description 字段。它可以与其他字段串联,具体取决于原始日志格式。
%{GREEDYDATA:login_to} security_result.description 当 %{GREEDYDATA:desc} 存在时,%{GREEDYDATA:login_to} 字段会与 %{GREEDYDATA:desc} 字段串联,以形成 security_result.description。
%{GREEDYDATA:user} target.user.userid %{GREEDYDATA:user} 字段映射到 target.user.userid。
%{HOST:principal_host} principal.hostname %{HOST:principal_host} 字段映射到 principal.hostname。
%{HOST:target_host} target.hostname %{HOST:target_host} 字段映射到 target.hostname。
%{INT:http_port} additional.fields.value.string_value %{INT:http_port} 字段映射到 additional.fields.value.string_value,键为“HTTP Port”。
%{INT:target_port} target.port %{INT:target_port} 字段会映射到 target.port 并转换为整数。
%{INT:telnet_port} additional.fields.value.string_value %{INT:telnet_port} 字段映射到 additional.fields.value.string_value,键为“Telnet Port”。
%{INT:tftp_port} additional.fields.value.string_value %{INT:tftp_port} 字段映射到 additional.fields.value.string_value,键为“TFTP Port”。
%{IP:principal_ip} principal.ip %{IP:principal_ip} 字段映射到 principal.ip。
%{IP:target_ip} target.ip %{IP:target_ip} 字段映射到 target.ip。
%{IPV4:principal_ip} principal.ip %{IPV4:principal_ip} 字段映射到 principal.ip。
%{IPV4:target_ip} target.ip %{IPV4:target_ip} 字段映射到 target.ip。
%{MAC:principal_mac} principal.mac %{MAC:principal_mac} 字段在转换为 [0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2}:[0-9a-f]{2} 格式后,会映射到 principal.mac。
%{USERNAME:target_host} target.hostname %{USERNAME:target_host} 字段映射到 target.hostname。
%{USERNAME:user} target.user.userid %{USERNAME:user} 字段映射到 target.user.userid。
%{WORD:auth_result} security_result.description 当 %{GREEDYDATA:desc} 存在时,%{WORD:auth_result} 字段会与 %{GREEDYDATA:desc} 字段串联,以形成 security_result.description。
%{WORD:proto} network.application_protocol 当 %{WORD:proto} 字段的值为“SSH”时,该字段会映射到 network.application_protocol。
timestamp metadata.event_timestamp 时间戳字段使用 grok 模式从原始日志数据中解析,并转换为时间戳对象。
extensions.auth.type 如果 proto 字段不为空,且 auth_action 字段为“logout”或“login”,则该值会设为“MACHINE”。
metadata.description 如果“metadata_description”字段不为空,则该字段会填充“metadata_description”字段的值。
metadata.event_type 该字段根据其他字段的值使用条件逻辑进行填充:- STATUS_STARTUP:如果 target_port_status 为“up”。- STATUS_SHUTDOWN:如果 target_port_status 为“down”。- USER_LOGOUT:如果 proto 不为空且 auth_action 为“logout”。- USER_LOGIN:如果 proto 不为空且 auth_action 为“login”。- STATUS_UPDATE:如果 metadata_description 与“state changed”匹配。- GENERIC_EVENT:如果上述条件均不满足。
metadata.log_type 该值硬编码为“BROCADE_SERVERIRON”。
metadata.product_name 该值硬编码为“ServerIron”。
metadata.vendor_name 该值已硬编码为“Brocade”。
security_result.action 如果 desc 字段包含“fail”,或者 auth_result 字段包含“fail”或“rejected”,则该值会设置为“BLOCK”。

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