收集 VyOS 記錄
本文說明如何使用 Bindplane 代理程式,將 VyOS 記錄檔擷取至 Google Security Operations。
VyOS 是開放原始碼網路路由器,可為防火牆事件、路由變更、VPN 連線和系統事件產生系統記錄訊息。
事前準備
請確認您符合下列必要條件:
- Google SecOps 執行個體
- Windows Server 2016 以上版本,或搭載
systemd的 Linux 主機 - Bindplane 代理程式與 VyOS 路由器之間的網路連線
- 如果透過 Proxy 執行,請確保防火牆通訊埠已根據 Bindplane 代理程式需求開啟
- 具備管理員權限,可透過 SSH 存取 VyOS 路由器
取得 Bindplane 代理程式的 Google SecOps 憑證
如要向 Google SecOps 驗證 Bindplane 代理程式,請選擇下列其中一種方法:
- 新部署作業:使用 Chronicle API (選項 1)。
- 舊版部署作業:在 2027 年 7 月 20 日停用 Ingestion API 前,請繼續使用擷取驗證檔案 (選項 2)。
方法 1:為 Chronicle API 建立服務帳戶 (建議)
- 登入 Google Cloud 控制台,選取連結至 Google SecOps 執行個體的 Google Cloud 專案。
- 依序前往 「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
- 按一下「建立服務帳戶」。
- 提供下列設定詳細資料:
- 服務帳戶名稱:輸入帳戶名稱 (例如
bindplane-ingest)。 - 服務帳戶說明:輸入說明 (例如
Bindplane agent log ingestion)。
- 服務帳戶名稱:輸入帳戶名稱 (例如
- 點按「Create and continue」(建立並繼續)。
- 在「將專案存取權授予這個服務帳戶」部分,按一下「選取角色」,然後選取「Chronicle 編輯者」。
- 依序點選「繼續」和「完成」。
- 按一下您建立的服務帳戶,然後前往「金鑰」分頁標籤。
- 依序點選「新增金鑰」>「建立新的金鑰」。
- 選取「JSON」,然後按一下「建立」。金鑰檔案會下載到電腦。
- 將金鑰檔案儲存為 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,使其與儲存路徑相符。 - 依序前往「IAM 與管理」>「設定」,然後複製「專案編號」。設定匯出工具時會用到。
方法 2:下載擷取驗證檔案 (舊版)
- 登入 Google SecOps 控制台。
- 依序前往「SIEM Settings」 > 「Collection Agents」。
- 下載擷取驗證檔案。
- 將檔案安全地儲存在要安裝 Bindplane 代理程式的系統中。
取得 Google SecOps 客戶 ID
- 登入 Google SecOps 控制台。
- 依序前往「SIEM 設定」 > 「設定檔」。
複製並儲存「機構詳細資料」專區中的「客戶 ID」。
安裝 Bindplane 代理程式
請按照下列操作說明,在 Windows 或 Linux 作業系統上安裝 Bindplane 代理程式。
Windows 安裝
- 以管理員身分開啟命令提示字元或 PowerShell。
執行下列指令:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet等待安裝完成。
執行下列指令,確認安裝成功:
sc query observiq-otel-collector服務應顯示為「RUNNING」。
安裝 Linux
- 開啟具有 root 或 sudo 權限的終端機。
執行下列指令:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh等待安裝完成。
執行下列指令,確認安裝成功:
sudo systemctl status observiq-otel-collector服務應顯示為「active (running)」。
其他安裝資源
如需其他安裝選項和疑難排解資訊,請參閱 Bindplane 代理程式安裝指南。
設定 Bindplane 代理程式,擷取系統記錄並傳送至 Google SecOps
找出設定檔
Linux:
sudo nano /opt/observiq-otel-collector/config.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
編輯設定檔
將
config.yaml的全部內容替換為下列設定:receivers: udplog: listen_address: "0.0.0.0:514" exporters: chronicle/vyos: 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: VYOS raw_log_field: body service: pipelines: logs/vyos_to_chronicle: receivers: - udplog exporters: - chronicle/vyos
設定參數
替換下列預留位置:
接收器設定:
listen_address:要接聽的 IP 位址和通訊埠:0.0.0.0在所有介面接聽電話 (建議)- 通訊埠
514是標準 syslog 通訊埠 (在 Linux 上需要根目錄;非根目錄請使用1514)
Exporter 設定:
creds_file_path:服務帳戶 JSON 金鑰檔案的完整路徑 (選項 1):- Linux:
/opt/observiq-otel-collector/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
customer_id:從 Google SecOps 控制台複製的客戶 IDlocation:將<LOCATION>替換為 Google SecOps 執行個體的區域 (例如us、europe或asia-southeast1)。匯出工具會在這個值前面加上chronicle.googleapis.com。如需完整清單,請參閱「區域性端點」。project:依序前往「IAM 與管理」>「設定」,然後將<PROJECT_NUMBER>替換為專案編號。endpoint:維持設為chronicle.googleapis.com。
舊版 Ingestion API 匯出工具
如果您使用選項 2 的擷取驗證檔案,請將
exporters區塊替換為下列內容。將creds_file_path設為擷取驗證檔案的路徑,如果您的執行個體位於美國境外,請將malachiteingestion-pa.googleapis.com替換為區域端點 (例如europe-malachiteingestion-pa.googleapis.com)。exporters: chronicle/vyos: compression: gzip creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: VYOS raw_log_field: body
儲存設定檔
- 編輯完成後,請儲存檔案:
- Linux:依序按下
Ctrl+O、Enter和Ctrl+X - Windows:依序點選「檔案」 > 「儲存」
- Linux:依序按下
重新啟動 Bindplane 代理程式,套用變更
如要在 Linux 中重新啟動 Bindplane 代理程式,請執行下列指令:
sudo systemctl restart observiq-otel-collector確認服務正在執行:
sudo systemctl status observiq-otel-collector查看記錄檔是否有錯誤:
sudo journalctl -u observiq-otel-collector -f
如要在 Windows 中重新啟動 Bindplane 代理程式,請選擇下列其中一個選項:
以管理員身分開啟命令提示字元或 PowerShell:
net stop observiq-otel-collector && net start observiq-otel-collector服務控制台:
- 按下
Win+R,輸入services.msc,然後按下 Enter 鍵。 - 找出「observIQ OpenTelemetry Collector」。
- 按一下滑鼠右鍵,然後選取「重新啟動」。
確認服務是否正在執行:
sc query observiq-otel-collector檢查記錄是否有錯誤:
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
- 按下
在 VyOS 中設定系統記錄檔
- 使用 SSH 連線至 VyOS 路由器。
進入設定模式:
configure設定遠端系統記錄主機 (將
<bindplane-ip>替換為 Bindplane 代理程式 IP 位址):set system syslog host <bindplane-ip> facility all level info set system syslog host <bindplane-ip> port 514 set system syslog host <bindplane-ip> protocol udp提交並儲存設定:
commit save
UDM 對應表
| 記錄欄位 | UDM 對應 | 邏輯 |
|---|---|---|
clientIp |
principal.ip |
從 DHCP 訊息擷取的用戶端 IP 位址。 |
clientMac |
principal.mac |
從 DHCP 訊息擷取的用戶端 MAC 位址。 |
datetime |
metadata.event_timestamp |
從記錄訊息中擷取的時間戳記。 |
dst_ipaddress |
target.ip |
從記錄訊息擷取的目的地 IP 位址。 |
hostname |
observer.hostname |
從記錄訊息中擷取的主機名稱。由剖析器根據 process 和其他欄位決定。可以是 GENERIC_EVENT、NETWORK_CONNECTION、NETWORK_DHCP 或 STATUS_UPDATE。硬式編碼為「VYOS」。 |
msg |
metadata.description |
記錄中的原始訊息或部分訊息,視剖析邏輯而定。如果 process 為「dhcpd」,請設為「DHCP Event」。硬式編碼為「VYOS DHCP」。硬式編碼為「VYOS」。 |
network.dhcp.chaddr |
network.dhcp.chaddr |
從 DHCP 訊息擷取的用戶端 MAC 位址。 |
network.dhcp.ciaddr |
network.dhcp.ciaddr |
DHCPREQUEST 訊息中的用戶端 IP 位址。DHCP 訊息作業碼。如果是 DHCPREQUEST 和 DHCPINFORM,請設為「BOOTREQUEST」;如果是 DHCPACK 和 DHCPNAK,請設為「BOOTREPLY」。DHCP 訊息類型。衍生自 eventType,可能為 REQUEST、ACK、INFORM、NAK 或 OFFER。 |
network.dhcp.yiaddr |
network.dhcp.yiaddr |
DHCPACK 或 DHCPOFFER 訊息中的 (用戶端) IP 位址。如果 process 為「dhcpd」,請設為「DHCP」。 |
pri_host |
principal.hostname |
DHCP 訊息中與用戶端相關聯的主機名稱。 |
rem_msg |
metadata.description |
初始剖析後訊息的其餘部分,有時用於說明。 |
src_ipaddress |
principal.ip |
從記錄訊息擷取的來源 IP 位址。 |
timestamp |
event.timestamp |
記錄項目的時間戳記。 |
變更記錄
還有其他問題嗎?向社群成員和 Google SecOps 專家尋求解答。