收集 OPNsense 防火牆記錄

本文說明如何使用 Bindplane 代理程式，將 OPNsense 防火牆記錄擷取至 Google Security Operations。

OPNsense 是開放原始碼防火牆和轉送平台，可針對防火牆規則比對、網路連線和系統事件產生 syslog 訊息。剖析器會使用 grok 和 CSV 剖析，從 CSV 格式的 filterlog 訊息中擷取欄位，並對應至統合式資料模型 (UDM)。

事前準備

請確認您符合下列必要條件：

• Google SecOps 執行個體
• Windows Server 2016 以上版本，或搭載 systemd 的 Linux 主機
• Bindplane 代理程式與 OPNsense 防火牆之間的網路連線
• 如果是在 Proxy 後方執行，請確認防火牆通訊埠已按照 Bindplane 代理程式規定開啟
• OPNsense 網頁介面的管理員權限

取得 Bindplane 代理程式的 Google SecOps 憑證

如要向 Google SecOps 驗證 Bindplane 代理程式，請選擇下列其中一種方法：

• 新部署作業：使用 Chronicle API (選項 1)。
• 舊版部署作業：在 2027 年 7 月 20 日停用 Ingestion API 前，請繼續使用擷取驗證檔案 (選項 2)。

方法 1：為 Chronicle API 建立服務帳戶 (建議)

1. 登入 Google Cloud 控制台，選取連結至 Google SecOps 執行個體的 Google Cloud 專案。
2. 依序前往 「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
3. 按一下「建立服務帳戶」。
4. 提供下列設定詳細資料：
   • 「Service account name」(服務帳戶名稱)：輸入帳戶名稱 (例如 bindplane-ingest)。
   • 「服務帳戶說明」：輸入說明 (例如 Bindplane agent log ingestion)。
5. 點按「Create and continue」(建立並繼續)。
6. 在「將專案存取權授予這個服務帳戶」部分，按一下「選取角色」，然後選取「Chronicle 編輯者」。
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)，或更新 config.yaml 中的 creds_file_path，使其與儲存檔案的路徑相符。
12. 依序前往「IAM & Admin」(IAM 與管理) >「Settings」(設定)，然後複製「Project number」(專案編號)。匯出工具設定時會用到。

方法 2：下載擷取驗證檔案 (舊版)

1. 登入 Google SecOps 控制台。
2. 依序前往「SIEM Settings」 > 「Collection Agents」。
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
   

   服務應顯示為「RUNNING」。

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 代理程式，擷取系統記錄並傳送至 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:
      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: 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 上需要根目錄；非根目錄請使用 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：依序前往「IAM 與管理」>「設定」，然後將 <PROJECT_NUMBER> 替換為專案編號。
  • endpoint：維持設為 chronicle.googleapis.com。

舊版擷取 API 匯出工具

• 如果您使用方式 2 的擷取驗證檔案，請將 exporters 區塊替換成下列內容。將 creds_file_path 設為擷取驗證檔案的路徑。如果執行個體位於美國境外，請將 malachiteingestion-pa.googleapis.com 替換為區域端點 (例如 europe-malachiteingestion-pa.googleapis.com)。

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

儲存設定檔

• 編輯完成後，請儲存檔案：
  • 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 中新增系統記錄檔伺服器設定

1. 登入 OPNsense 網頁介面。
2. 依序前往「System」>「Settings」>「Logging」。
3. 在「Remote Logging」部分，勾選「Send logs to remote syslog server」方塊。
4. 在「Remote Syslog Servers」(遠端 Syslog 伺服器) 欄位中，輸入 Syslog 伺服器的 IP 位址，包括通訊埠 (例如 10.10.10.10:514)。
5. 選取「Local0」Local0做為系統記錄設施。
6. 將系統記錄層級設為「Alert」。
7. 點選「儲存」來套用變更。

UDM 對應表

記錄欄位	UDM 對應	邏輯
column1	security_result.rule_id	直接從 column1 對應。
column10	additional.fields[].key: "tos" additional.fields[].value.string_value: column10 的值	直接從 column10 對應，並以「tos」鍵巢狀嵌入 additional.fields。
column12	additional.fields[].key: "ttl" additional.fields[].value.string_value: column12 的值	直接從 column12 對應，巢狀結構位於 additional.fields 下方，且鍵為「ttl」。
column13	additional.fields[].key：「Id」 additional.fields[].value.string_value：column13 的值	直接從 column13 對應，巢狀結構位於 additional.fields 下方，且鍵為「Id」。
column14	additional.fields[].key: "offset" additional.fields[].value.string_value: column14 的值	直接從 column14 對應，並以「offset」鍵巢狀置於 additional.fields 下方。
column15	additional.fields[].key: "flags" additional.fields[].value.string_value: Value of column15	直接從 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_value：column24 的值	如果 column17 為 TCP，則直接從 column24 對應，並以「tcp_flags」鍵巢狀結構在 additional.fields 下。
column29	additional.fields[].key：「tcp_options」 additional.fields[].value.string_value：column29 的值	如果 column17 為 TCP，則直接從 column29 對應，並以「tcp_options」鍵巢狀結構在 additional.fields 下。
column4	additional.fields[].key: "tracker" additional.fields[].value.string_value: column4 的值	直接從 column4 對應，並以「tracker」鍵巢狀置於 additional.fields 下方。
column5	additional.fields[].key：「介面」 additional.fields[].value.string_value：column5 的值	直接從 column5 對應，並以「interface」鍵巢狀置於 additional.fields 下方。
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 位址都存在，請設為「NETWORK_CONNECTION」，否則設為「GENERIC_EVENT」。硬式編碼為「OPNSENSE」。硬式編碼為「OPNSENSE」。
message	各種欄位	使用 grok 和 csv 篩選器剖析，擷取各種欄位。如需特定對應，請參閱其他資料列。
ts	metadata.event_timestamp.seconds、timestamp.seconds	使用 grok 從訊息欄位剖析，然後轉換為時間戳記。秒數值會用於填入 metadata.event_timestamp.seconds 和 timestamp.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 專業人員尋求解答。