收集 OPNsense 防火墙日志

支持:

本文档介绍了如何使用 Bindplane 代理将 OPNsense 防火墙日志注入 Google Security Operations。

OPNsense 是一个开源防火墙和路由平台,可为防火墙规则匹配、网络连接和系统事件生成 syslog 消息。解析器使用 grok 和 CSV 解析从 CSV 格式的 filterlog 消息中提取字段,并将这些字段映射到统一数据模型 (UDM)。

准备工作

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

  • Google SecOps 实例
  • Windows Server 2016 或更高版本,或者具有 systemd 的 Linux 主机
  • Bindplane 代理与 OPNsense 防火墙之间的网络连接
  • 如果通过代理运行,请确保防火墙端口根据 Bindplane 代理要求处于开放状态
  • 对 OPNsense 网页界面的管理员访问权限

获取 Google SecOps 注入身份验证文件

  1. 登录 Google SecOps 控制台。
  2. 前往 SIEM 设置 > 收集代理
  3. 下载数据注入身份验证文件 。将该文件安全地保存在将安装 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/opnsense:
            compression: gzip
            creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
            customer_id: '<customer_id>'
            endpoint: malachiteingestion-pa.googleapis.com
            log_type: OPNSENSE
            raw_log_field: body
    
    service:
        pipelines:
            logs/opnsense_to_chronicle:
                receivers:
                    - udplog
                exporters:
                    - chronicle/opnsense
    

配置参数

替换以下占位符:

  • 接收器配置

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

    • creds_file_path:注入身份验证文件的完整路径:
      • Linux: /etc/bindplane-agent/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id:从 Google SecOps 控制台复制的客户 ID
    • endpoint:区域级端点网址:
      • 美国malachiteingestion-pa.googleapis.com
      • 欧洲: europe-malachiteingestion-pa.googleapis.com
      • 亚洲: asia-southeast1-malachiteingestion-pa.googleapis.com
      • 如需查看完整列表,请参阅区域级端点

保存配置文件

  • 修改后,保存文件:
    • 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"
        

向 OPNsense 添加 syslog 服务器配置

  1. 登录 OPNsense 网页界面。
  2. 前往系统 > 设置 > 日志记录
  3. 远程日志记录 部分,选中相应复选框以启用将日志发送到远程 syslog 服务器
  4. 远程 Syslog 服务器 字段中,输入 syslog 服务器的 IP 地址,包括端口(例如 10.10.10.10:514)。
  5. 选择 Local0 作为 syslog 工具。
  6. 将 syslog 级别设置为 Alert
  7. 点击保存 应用更改。

UDM 映射表

日志字段 UDM 映射 逻辑
column1 security_result.rule_id 直接从 column1 映射。
column10 additional.fields[].key:“tos”
additional.fields[].value.string_valuecolumn10 的值
直接从 column10 映射,嵌套在 additional.fields 下,键为“tos”。
column12 additional.fields[].key:“ttl”
additional.fields[].value.string_valuecolumn12 的值
直接从 column12 映射,嵌套在 additional.fields 下,键为“ttl”。
column13 additional.fields[].key:“Id”
additional.fields[].value.string_valuecolumn13 的值
直接从 column13 映射,嵌套在 additional.fields 下,键为“Id”。
column14 additional.fields[].key:“offset”
additional.fields[].value.string_valuecolumn14 的值
直接从 column14 映射,嵌套在 additional.fields 下,键为“offset”。
column15 additional.fields[].key:"flags"
additional.fields[].value.string_valuecolumn15 的值
直接从 column15 映射,嵌套在 additional.fields 下,键为“flags”。
column17 network.ip_protocol 在转换为大写后直接从 column17 映射。
column18 network.received_bytes 在转换为无符号整数后直接从 column18 映射。
column19 principal.ip 直接从 column19 映射。
column20 target.ip 直接从 column20 映射。
column21 principal.port(如果 column17 是 TCP 或 UDP)
additional.fields[].key:"data_length"
additional.fields[].value.string_value:提取的值(如果 column17 是 ICMP、GRE、ESP 或 IGMP)
如果 column17 是 TCP/UDP,则直接从 column21 映射并转换为整数。否则,使用 grok 提取“datalength”值,并将其放置在 additional.fields 中,键为“data_length”。
column22 target.port 如果 column17 是 TCP 或 UDP,则直接从 column22 映射并转换为整数。
column24 additional.fields[].key:"tcp_flags"
additional.fields[].value.string_valuecolumn24 的值
如果 column17 是 TCP,则直接从 column24 映射,嵌套在 additional.fields 下,键为“tcp_flags”。
column29 additional.fields[].key:“tcp_options”
additional.fields[].value.string_valuecolumn29 的值
如果 column17 是 TCP,则直接从 column29 映射,嵌套在 additional.fields 下,键为“tcp_options”。
column4 additional.fields[].key:“tracker”
additional.fields[].value.string_valuecolumn4 的值
直接从 column4 映射,嵌套在 additional.fields 下,键为“tracker”。
column5 additional.fields[].key:"interface"
additional.fields[].value.string_valuecolumn5 的值
直接从 column5 映射,嵌套在 additional.fields 下,键为“interface”。
column6 security_result.rule_type 直接从 column6 映射。
column7 security_result.action column7 映射。如果为“block”,则转换为大写“BLOCK”。如果为“pass”,则设置为“ALLOW”。
column8 network.direction column8 映射。如果为“in”,则设置为“INBOUND”。如果为“out”,则设置为“OUTBOUND”。
domain principal.administrative_domain 直接从 grok 提取的 domain 映射。如果同时存在主 IP 地址和目标 IP 地址,则设置为“NETWORK_CONNECTION”,否则设置为“GENERIC_EVENT”。 硬编码为“OPNSENSE”。硬编码为“OPNSENSE”。
message 各种字段 使用 grok 和 CSV 过滤器进行解析,以提取各种字段。如需了解具体映射,请参阅其他行。
ts metadata.event_timestamp.secondstimestamp.seconds 使用 grok 从消息字段解析,然后转换为时间戳。秒值用于填充 metadata.event_timestamp.secondstimestamp.seconds
application principal.application 直接从 grok 提取的 application 映射。
column27 event.idm.read_only_udm.additional.fields 从更新日志映射
column2 event.idm.read_only_udm.additional.fields 从更新日志映射
column3 event.idm.read_only_udm.additional.fields 从更新日志映射
column11 event.idm.read_only_udm.additional.fields 从更新日志映射
column26 event.idm.read_only_udm.additional.fields 从更新日志映射
column28 event.idm.read_only_udm.additional.fields 从更新日志映射
column25 event.idm.read_only_udm.additional.fields 从更新日志映射
column16 event.idm.read_only_udm.additional.fields 从更新日志映射
column9 event.idm.read_only_udm.additional.fields 从更新日志映射

更新日志

查看此解析器的更新日志

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