收集 Brocade 交换机日志

解析器版本:5.0

支持范围:

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

Brocade 交换机(光纤通道 SAN 交换机)会针对网络结构事件、可用区变更、登录/退出活动和系统事件生成 syslog 消息。解析器会标准化字段并将其映射到统一数据模型 (UDM)。

准备工作

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

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

获取 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_switch:
        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_SWITCH
        raw_log_field: body
    
    service:
      pipelines:
        logs/brocade_switch_to_chronicle:
          receivers:
            - udplog
          exporters:
            - chronicle/brocade_switch
    

配置参数

替换以下占位符:

  • 接收器配置:

    • 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_switch:
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: BROCADE_SWITCH
        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 交换机导出 syslog

  1. 使用 SSH 或 Telnet 并提供适当的凭证连接到 Brocade 交换机。
  2. 运行以下命令,指定 syslog 服务器 (Bindplane) 的 IP 地址和端口:

    syslogadmin --set -ip <BINDPLANE_IP> -port 514
    
  3. 运行以下命令,显示已配置的 syslog 服务器:

    syslogadmin --show -ip
    

UDM 映射表

日志字段 UDM 映射 逻辑
application additional.fields[].key: "application"
additional.fields[].value.string_value:
当 KV_DATA 字段存在时,从原始日志中的 application@1588 字段提取的值。
class additional.fields[].key: "class"
additional.fields[].value.string_value:
当 KV_DATA 字段存在时,从原始日志中的 class@1588 字段提取的值。
domain principal.administrative_domain 从与 domain 字段匹配的 grok 模式中提取的值。
Event additional.fields[].key: "event_category"
additional.fields[].value.string_value:
当 KV_DATA 字段存在时,从原始日志中的 arg0@1588 字段提取的值。
event_id metadata.product_log_id 从与 event_id 字段匹配的 grok 模式中提取的值。
event_type metadata.product_event_type 从与 event_type 字段匹配的 grok 模式中提取的值。
flags additional.fields[].key: "flags"
additional.fields[].value.string_value:
从与 flags 字段匹配的 grok 模式中提取的值。
Info metadata.description 从 Info 字段中提取的值,使用 grok 解析。
interface app_protocol_src 当 KV_DATA 字段存在时,从原始日志中的 interface@1588 字段提取的值。用于派生 network.application_protocol。
ip principal.ip 从 ip 字段中提取的值,使用 grok 进行解析。如果与从 Info 字段中提取的 IP 不同,则合并到 principal.ip 中。
Info,IP Addr principal.ip 从 Info 字段内的 IP Addr 字段中提取的值,使用 grok 进行解析。
log additional.fields[].key: "log"
additional.fields[].value.string_value:
当 KV_DATA 字段存在时,从原始日志中的 log@1588 字段提取的值。
msg metadata.description 从 msg 字段中提取的值,使用 grok 解析。
msgid additional.fields[].key: "msgid"
additional.fields[].value.string_value:
当 KV_DATA 字段存在时,从原始日志中的 msgid@1588 字段提取的值。
prin_host principal.hostname
principal.asset.hostname
从与 prin_host 字段匹配的 grok 模式中提取的值。
product_version metadata.product_version 从与 product_version 字段匹配的 grok 模式中提取的值。
repeat_count additional.fields[].key: "repeat_count"
additional.fields[].value.string_value:
从 msg 字段中提取的值,使用 grok 解析。
role,user_role principal.user.attribute.roles[].name 从 role@1588 或 user_role 字段中提取的值。如果值为“admin”,则会替换为“Admin”。
sequence_number additional.fields[].key: "sequence_number"
additional.fields[].value.string_value:
从与 sequence_number 字段匹配的 grok 模式中提取的值。
severity security_result.severity 从 severity 字段中提取的值,使用 grok 进行解析。映射到 UDM 严重级别值(INFORMATIONAL、ERROR、CRITICAL、MEDIUM)。
Status security_result.summary 从 Status 字段中提取的值。
switch_name additional.fields[].key: "switch_name"
additional.fields[].value.string_value:
从与 switch_name 字段匹配的 grok 模式中提取的值。
target_application target.application 从与 target_application 字段匹配的 grok 模式中提取的值。
time additional.fields[].key: "time"
additional.fields[].value.string_value:
从 kv_data3 字段内的 time 字段中提取的值。
timestamp metadata.event_timestamp.seconds 从 timestamp 字段中提取的值,使用日期过滤器进行解析。
user principal.user.userid
principal.user.user_display_name
从 user 或 user@1588 字段中提取的值,使用 grok 进行解析。从principal.hostname复制的数据。从principal.ip复制的数据。从 metadata.product_event_type 复制或根据条件设置为“STATUS_UPDATE”。从日志的 create_time.nanos 复制。由解析器逻辑根据 has_principal、has_target、has_userid 和 event_type 的值确定。可以是“SYSTEM_AUDIT_LOG_UNCATEGORIZED”“STATUS_UPDATE”或“GENERIC_EVENT”。硬编码为“BROCADE_SWITCH”。硬编码为“BROCADE”。硬编码为“BROCADE_SWITCH”。派生自 interface 字段,或者如果 interface 字段包含“SSH”,则设置为“SSH”。
CLI event.idm.read_only_udm.metadata.description 从更新日志映射
prin_host event.idm.read_only_udm.intermediary.hostname 从更新日志映射

更新日志

查看此解析器的更新日志

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