收集 F5 BIG-IP APM 記錄

剖析器版本:6.0

支援:

本文說明如何使用 Bindplane,將 F5 BIG-IP APM 記錄擷取至 Google Security Operations。

F5 BIG-IP Access Policy Manager (APM) 可提供安全且統一的應用程式、API 和資料存取權。這項服務提供情境感知存取控管機制,並具備單一登入、多重驗證和 SSL VPN 功能,可保護企業網路。剖析器會從 F5 BIG-IP APM syslog 格式的記錄中擷取欄位。它會使用 grok 和/或 kv 剖析記錄訊息,然後將這些值對應至統合式資料模型 (UDM)。此外,也會為事件來源和類型設定預設中繼資料值。

事前準備

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

  • Google SecOps 執行個體
  • Windows Server 2016 以上版本,或搭載 systemd 的 Linux 主機
  • 如果是在 Proxy 後方執行,請確認防火牆通訊埠已按照 Bindplane 代理程式規定開啟
  • F5 BIG-IP 管理介面的特殊存取權

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

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

  • 新部署作業:使用 Chronicle API (選項 1)。
  • 舊版部署作業:繼續使用擷取驗證檔案 (選項 2),直到 Ingestion API 於 2027 年 7 月 20 日停用。
  1. 登入 Google Cloud 控制台,選取連結至 Google SecOps 執行個體的 Google Cloud 專案。
  2. 依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  3. 按一下「建立服務帳戶」。
  4. 提供下列設定詳細資料:
    • 服務帳戶名稱:輸入帳戶名稱 (例如 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/chronicle_w_labels:
        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: '/path/to/ingestion-authentication-file.json'
        customer_id: 'YOUR_CUSTOMER_ID'
        endpoint: chronicle.googleapis.com
        log_type: 'F5_BIGIP_APM'
        raw_log_field: body
        ingestion_labels:
    
    service:
      pipelines:
        logs/source0__chronicle_w_labels-0:
          receivers:
            - udplog
          exporters:
            - chronicle/chronicle_w_labels
    

設定參數

  • 替換下列預留位置:

    • 接收器設定:

      • udplog:使用 udplog 進行 UDP 系統記錄,或使用 tcplog 進行 TCP 系統記錄
      • 0.0.0.0:要接聽的 IP 位址 (0.0.0.0 可接聽所有介面)
      • 514:要監聽的通訊埠編號 (標準 syslog 通訊埠)
    • 匯出工具設定:

      • creds_file_path:服務帳戶 JSON 金鑰檔案的完整路徑 (選項 1):
        • Linux:/opt/observiq-otel-collector/ingestion-auth.json
        • Windows:C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
      • YOUR_CUSTOMER_ID:「取得客戶 ID」部分的客戶 ID
      • location:將 <LOCATION> 替換為 Google SecOps 執行個體的區域 (例如 us、europe 或 asia-southeast1)。匯出工具會在這個值前面加上 chronicle.googleapis.com。如需完整清單,請參閱「區域性端點」。
      • project:依序前往「IAM 與管理」>「設定」,然後將 <PROJECT_NUMBER> 替換為專案編號。
      • endpoint:維持設為 chronicle.googleapis.com。
      • log_type:記錄類型,與 Chronicle 中顯示的完全一致 (F5_BIGIP_APM)

舊版擷取 API 匯出工具

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

    exporters:
      chronicle/chronicle_w_labels:
        compression: gzip
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        customer_id: 'YOUR_CUSTOMER_ID'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: 'F5_BIGIP_APM'
        raw_log_field: body
        ingestion_labels:
    

儲存設定檔

  • 編輯完畢後,請儲存檔案:
    • 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"
        

設定 F5 BIG-IP APM syslog 轉送

  1. 登入 F5 BIG-IP 網頁介面 (TMUI/Configuration Utility)。
  2. 依序前往「System」 > 「Logs」 > 「Configuration」 > 「Remote Logging」。
  3. 在「Remote Logging」(遠端記錄) 部分,提供下列設定詳細資料:
    • 遠端 IP:輸入 Bindplane 代理程式主機的 IP 位址。
    • 遠端通訊埠:輸入 514。
  4. 按一下「新增」。
  5. 按一下「更新」儲存設定。
  6. 如要透過 CLI 設定高速記錄 (HSL),取得詳細的 APM 記錄,請按照下列步驟操作:

    1. 透過 SSH 連線至 F5 BIG-IP 系統。
    2. 執行下列指令:

      tmsh create ltm pool syslog_pool members add { BINDPLANE_IP:514 }
      tmsh create sys log-config destination remote-high-speed-log secops_hsl pool-name syslog_pool protocol udp
      tmsh create sys log-config destination remote-syslog secops_syslog remote-high-speed-log secops_hsl
      tmsh create sys log-config publisher secops_publisher destinations add { secops_syslog }
      tmsh save sys config
      
      • 將 BINDPLANE_IP 替換為 Bindplane 代理程式主機的 IP 位址。
  7. 將發布者指派給 APM 存取設定檔:

    1. 依序前往「Access」>「Profiles / Policies」>「Access Profiles」。
    2. 選取目標存取設定檔。
    3. 在「記錄設定」分頁中,選取已建立的發布商。
    4. 按一下「Update」。
  8. 檢查 Bindplane 代理程式記錄,確認系統記錄訊息是否已傳送。

UDM 對應表

記錄欄位 UDM 對應 邏輯
調度應用程式資源 principal.application 這個值取自 grok 篩選器擷取的應用程式欄位。
bytes_in network.received_bytes 這個值取自 grok 篩選器擷取的 bytes_in 欄位,並轉換為不帶正負號的整數。
bytes_out network.sent_bytes 這個值取自 grok 篩選器擷取的 bytes_out 欄位,並轉換為不帶正負號的整數。
cmd_data principal.process.command_line 這個值取自 kv 篩選器擷取的 cmd_data 資料欄位。
destination_ip target.ip 這個值取自 grok 篩選器擷取的 destination_ip 欄位。
destination_port target.port 這個值取自 grok 篩選器擷取的 destination_port 欄位,並轉換為整數。
資料夾 principal.process.file.full_path 這個值取自 kv 篩選器擷取的資料夾欄位。
geoCountry principal.location.country_or_region 這個值取自 grok 篩選器擷取的 geoCountry 欄位。
geoState principal.location.state 這個值取自 grok 篩選器擷取的 geoState 欄位。
inner_msg security_result.description 如果沒有其他特定說明,系統會從 grok 篩選器擷取的 inner_msg 欄位中擷取值。
ip_protocol network.ip_protocol 這個值取自 grok 篩選器擷取的 ip_protocol 欄位。
principal_hostname principal.hostname 這個值取自 grok 篩選器擷取的 principal_hostname 欄位。
principal_ip principal.ip 這個值取自 grok 篩選器擷取的 principal_ip 欄位。
process_id principal.process.pid 這個值取自 grok 篩選器擷取的 process_id 欄位。
角色 user_role.name 這個值取自 grok 篩選器擷取的角色欄位。如果角色欄位包含「admin」(不區分大小寫),值會設為「ADMINISTRATOR」。
嚴重性 security_result.severity_details 這裡會儲存來自系統記錄訊息的原始值。這個值是使用條件式邏輯從嚴重程度欄位衍生而來:, CRITICAL -> CRITICAL , ERR -> ERROR , ALERT, EMERGENCY -> HIGH , INFO, NOTICE -> INFORMATIONAL , DEBUG -> LOW , WARN -> MEDIUM
source_ip principal.ip 這個值取自 grok 篩選器擷取的 source_ip 欄位。
source_port principal.port 這個值取自 grok 篩選器擷取的 source_port 欄位,並轉換為整數。
狀態 security_result.summary 這個值取自 kv 篩選器擷取的狀態欄位。
時間戳記 metadata.event_timestamp, timestamp 這個值取自 grok 篩選器擷取的時間戳記欄位,並剖析為時間戳記物件。頂層事件物件中的時間戳記欄位也會取得這個值。
使用者 principal.user.userid 這個值取自 grok 篩選器擷取的使用者欄位,並已移除「id」或「ID」前置字元。這個值是根據其他欄位是否存在而衍生:如果使用者存在:USER_UNCATEGORIZED;如果 source_ip 和 destination_ip 存在:NETWORK_CONNECTION;如果 principal_ip 或 principal_hostname 存在:STATUS_UPDATE;否則:GENERIC_EVENT。硬式編碼為「BIGIP_APM」。硬式編碼為「F5」。如果結果欄位為「failed」,則值會設為「BLOCK」。
facility event.idm.read_only_udm.additional.fields 從變更記錄對應
Tunnel_Type event.idm.read_only_udm.additional.fields 從變更記錄對應
partition event.idm.read_only_udm.additional.fields 從變更記錄對應
priority event.idm.read_only_udm.additional.fields 從變更記錄對應
session_id event.idm.read_only_udm.network.session_id 從變更記錄對應
Client_IP event.idm.read_only_udm.principal.ip 和 event.idm.read_only_udm.principal.asset.ip 從變更記錄對應
Assigned_PPP_Dynamic_IPv4 event.idm.read_only_udm.target.ip 和 event.idm.read_only_udm.target.asset.ip 從變更記錄對應
ID event.idm.read_only_udm.security_result.rule_id 從變更記錄對應
resource_name event.idm.read_only_udm.about.resource.name 從變更記錄對應
log_id event.idm.read_only_udm.metadata.product_log_id 從變更記錄對應
f5_partition event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
f5_object_name event.idm.read_only_udm.target.resource.name 從變更記錄對應
listener_name event.idm.read_only_udm.target.application 從變更記錄對應
geoContinent event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
reputation event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
syslog_priority event.idm.read_only_udm.additional.fields 從變更記錄對應
User-Agent event.idm.read_only_udm.network.http.user_agent 從變更記錄對應
User-Agent event.idm.read_only_udm.network.http.parsed_user_agent 從變更記錄對應
http_protocol_info event.idm.read_only_udm.additional.fields 從變更記錄對應
X-Forwarded-For event.idm.read_only_udm.additional.fields 從變更記錄對應
Accept-Encoding event.idm.read_only_udm.additional.fields 從變更記錄對應
Accept event.idm.read_only_udm.additional.fields 從變更記錄對應
host event.idm.read_only_udm.target.ip 從變更記錄對應
http_protocol_info event.idm.read_only_udm.network.application_protocol 從變更記錄對應
hostname event.idm.read_only_udm.principal.hostname 從變更記錄對應
hostname event.idm.read_only_udm.principal.asset.hostname 從變更記錄對應
bigip_mgmt_ip event.idm.read_only_udm.target.ip 從變更記錄對應
bigip_mgmt_ip event.idm.read_only_udm.target.asset.ip 從變更記錄對應
bigip_mgmt_ip2 event.idm.read_only_udm.target.ip 從變更記錄對應
bigip_mgmt_ip2 event.idm.read_only_udm.target.asset.ip 從變更記錄對應
client_ip_geo_location event.idm.read_only_udm.principal.location.country_or_region 從變更記錄對應
client_port event.idm.read_only_udm.principal.port 從變更記錄對應
client_request_uri event.idm.read_only_udm.principal.url 從變更記錄對應
configuration_date_time event.idm.read_only_udm.additional.fields 從變更記錄對應
context_name event.idm.read_only_udm.principal.administrative_domain 從變更記錄對應
context_type event.idm.read_only_udm.principal.application 從變更記錄對應
dest_ip event.idm.read_only_udm.target.ip 從變更記錄對應
dest_ip event.idm.read_only_udm.target.asset.ip 從變更記錄對應
dest_port event.idm.read_only_udm.target.port 從變更記錄對應
device_product event.idm.read_only_udm.target.resource.name 從變更記錄對應
device_version event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
errdefs_msgno event.idm.read_only_udm.security_result.rule_id 從變更記錄對應
http_method event.idm.read_only_udm.network.http.method 從變更記錄對應
http_protocol_info event.idm.read_only_udm.network.http.user_agent 從變更記錄對應
http_protocol_info event.idm.read_only_udm.network.http.parsed_user_agent 從變更記錄對應
route_domain event.idm.read_only_udm.additional.fields 從變更記錄對應
captcha_status event.idm.read_only_udm.additional.fields 從變更記錄對應
browser_verification_status event.idm.read_only_udm.additional.fields 從變更記錄對應
client_type event.idm.read_only_udm.additional.fields 從變更記錄對應
jailbroken_or_rooted_device event.idm.read_only_udm.additional.fields 從變更記錄對應
mobile_debugger_enabled_device event.idm.read_only_udm.additional.fields 從變更記錄對應
imei event.idm.read_only_udm.additional.fields 從變更記錄對應
http_request event.idm.read_only_udm.additional.fields 從變更記錄對應
human_behaviour event.idm.read_only_udm.additional.fields 從變更記錄對應
timestamp event.idm.read_only_udm.metadata.event_timestamp 從變更記錄對應
virtual_server_name event.idm.read_only_udm.principal.cloud.vpc.name 從變更記錄對應
device_id event.idm.read_only_udm.principal.asset.asset_id 從變更記錄對應
host event.idm.read_only_udm.target.hostname 從變更記錄對應
host event.idm.read_only_udm.target.asset.hostname 從變更記錄對應
request_date_time event.idm.read_only_udm.metadata.collected_timestamp 從變更記錄對應
profile_name event.idm.read_only_udm.principal.user.user_display_name 從變更記錄對應
support_id event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
request_status event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
previous_action event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
anomaly_categories event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
previous_support_id event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
session_id event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
configured_mitigation_action event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
configured_mitigation_action_reason event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
actual_mitigation_action event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
actual_mitigation_action_reason event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
anomalies event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
browser_configured_verification_action event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
browser_actual_verification_action event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
browser_actual_verification_action_reason event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
previous_request_date_time event.idm.read_only_udm.security_result.detection_fields 從變更記錄對應
action event.idm.read_only_udm.security_result.action_details 從變更記錄對應
reason event.idm.read_only_udm.security_result.summary 從變更記錄對應
bot_signature event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
bot_signature_category event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
device_id_status event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
bot_name event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
device_id_action event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
previous_initiated_action event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
class event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
previous_initiated_action_status event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
enforced_by event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
additional_bot_signatures event.idm.read_only_udm.principal.resource.attribute.labels 從變更記錄對應
headless_signatures event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
micro_service_matched_wildcard_url event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
micro_service_hostname event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
mobile_is_app event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
mobile_in_emulation_mode event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
challenge_failure_reason event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
os_name event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
classification_reason event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
new_request_status event.idm.read_only_udm.target.resource.attribute.labels 從變更記錄對應
micro_service_name event.idm.read_only_udm.principal.resource.name 從變更記錄對應
micro_service_type event.idm.read_only_udm.principal.resource.resource_subtype 從變更記錄對應
application_display_name event.idm.read_only_udm.target.application 從變更記錄對應
application_version event.idm.read_only_udm.target.platform_version 從變更記錄對應
http_protocol_indication event.idm.read_only_udm.network.application_protocol_version 從變更記錄對應
client_ip event.idm.read_only_udm.principal.ip 從變更記錄對應
client_ip event.idm.read_only_udm.principal.asset.ip 從變更記錄對應
principal_hostname event.idm.read_only_udm.intermediary.hostname 和 event.idm.read_only_udm.intermediary.asset.hostname 從變更記錄對應
rulename event.idm.read_only_udm.security_result.rule_name 從變更記錄對應
filepath event.idm.read_only_udm.target.file.full_path 從變更記錄對應
appprotocol event.idm.read_only_udm.network.application_protocol 從變更記錄對應

變更記錄

查看這個剖析器的變更記錄

還有其他問題嗎?向社群成員和 Google SecOps 專家尋求解答。