收集 JFrog Artifactory 記錄

本文說明如何使用 Bindplane 代理程式，將 JFrog Artifactory 記錄檔擷取至 Google Security Operations。

JFrog Artifactory 是通用構件存放區管理工具，可針對存放區存取事件、驗證、設定變更和構件作業產生系統記錄訊息。剖析器會使用 grok 模式，從 syslog 和 JSON 格式的記錄中擷取欄位，並對應至統合式資料模型 (UDM)。

事前準備

請確認您已完成下列事前準備事項：

• Google SecOps 執行個體
• Windows Server 2016 以上版本，或搭載 systemd 的 Linux 主機
• Bindplane 代理程式與 JFrog Artifactory 伺服器之間的網路連線
• 如果透過 Proxy 執行，請確保防火牆通訊埠已根據 Bindplane 代理程式需求開啟
• JFrog Artifactory 執行個體的 SSH 存取權

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

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

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

方法 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/jfrog_artifactory:
      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: JFROG_ARTIFACTORY
      raw_log_field: body
  
  service:
    pipelines:
      logs/jfrog_artifactory_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/jfrog_artifactory
  

設定參數

請替換下列預留位置：

• 接收器設定：

  • 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/jfrog_artifactory:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: JFROG_ARTIFACTORY
      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"
       

設定 JFrog Artifactory 系統記錄檔

1. 連線至 JFrog Artifactory 執行個體。

2. 編輯 $JFROG_HOME/artifactory/var/etc/artifactory/logback.xml 檔案：

   vi $JFROG_HOME/artifactory/var/etc/artifactory/logback.xml
   

3. 在檔案中新增下列 syslog 附加器：

   <appender name="SYSLOG" class="ch.qos.logback.classic.net.SyslogAppender">
       <syslogHost><BINDPLANE_IP></syslogHost>
       <facility>SYSLOG</facility>
       <suffixPattern>[%thread] %logger %msg</suffixPattern>
   </appender>
   

   • 將 <BINDPLANE_IP> 替換為實際的 Bindplane 代理程式 IP 位址。

4. 將系統記錄附加程式參照新增至根記錄器：

   <root>
       <level value="debug"/>
       <appender-ref ref="CONSOLE"/>
       <appender-ref ref="FILE"/>
       <appender-ref ref="SYSLOG"/>
   </root>
   

5. 按下 ESC 並輸入 :wq，即可儲存檔案。

UDM 對應表

記錄欄位	UDM 對應	邏輯
動作	read_only_udm.metadata.product_event_type	原始記錄中的 action 值會轉換為小寫並對應。
datetime	read_only_udm.metadata.event_timestamp	系統會剖析原始記錄的 datetime 欄位，並轉換為時間戳記。
主機名稱	read_only_udm.principal.hostname	直接從原始記錄的「hostname」欄位對應。
id	read_only_udm.metadata.product_log_id	直接從原始記錄的 id 欄位 (來自 JSON 酬載) 對應。
ip	read_only_udm.principal.ip	直接從原始記錄的 ip 欄位對應。硬式編碼為「USER_RESOURCE_ACCESS」。硬式編碼為「JFROG_ARTIFACTORY」。硬式編碼為「Artifactory」。硬式編碼為「JFROG」。
owner	read_only_udm.principal.user.userid	如果原始記錄 (來自 JSON 酬載) 中沒有 username，則會對應。
repo_name	read_only_udm.target.resource.name	直接從原始記錄的 repo_name 欄位對應。
repo_type	read_only_udm.target.resource.resource_subtype	直接從原始記錄的 repo_type 欄位對應。
scope	read_only_udm.target.resource.name	直接從原始記錄的「scope」欄位 (來自 JSON 酬載) 對應。
範圍	read_only_udm.target.resource.resource_subtype	如果原始記錄中含有 scope，則會硬式編碼為「scope」。
sequenceId	read_only_udm.metadata.product_log_id	系統會從 sequenceId 欄位移除引號，然後進行對應。
subject	read_only_udm.about.labels.key	如果原始記錄中含有 subject，則硬式編碼為「subject」。
主旨	read_only_udm.about.labels.value	直接從原始記錄的「subject」欄位 (來自 JSON 酬載) 對應。
type	read_only_udm.metadata.product_event_type	直接從原始記錄的 type 欄位 (來自 JSON 酬載) 對應。
使用者	read_only_udm.principal.user.userid	直接從原始記錄的 user 欄位對應。
使用者名稱	read_only_udm.principal.user.userid	直接從原始記錄的 username 欄位 (來自 JSON 酬載) 對應。
data.repository_key", "data.release_bundle_name", "data.release_bundle_version", "data.property_key", "data.property_values", "data.platforms.architecture", and "data.platforms.os	additional.fields	從變更記錄對應
data.repo_key" ,"subscription_key","source","image_name", "data.platforms	additional.fields	從變更記錄對應
domain	principal.administrative_domain	從變更記錄對應
data.path	target.file.full_path	從變更記錄對應
data.name	target.user.user_display_name	從變更記錄對應
data.size	target.file.size	從變更記錄對應
SHA256	target.process.file.sha256	從變更記錄對應
target_ip	target.ip	從變更記錄對應
desc	metadata.description	從變更記錄對應
method	network.http.method	從變更記錄對應
url	target.url	從變更記錄對應
prin_url	principal.url	從變更記錄對應
response_code	network.http.response_code	從變更記錄對應
RequestMethod	network.http.method	從變更記錄對應
RequestPath	target.url	從變更記錄對應
DownstreamContentSize" and "DownstreamStatus	Additional.Fields	從變更記錄對應
ServiceAddr	principal.hostname	從變更記錄對應
ClientAddr	target.ip	從變更記錄對應
user_agent	network.http.user_agent	從變更記錄對應
level	security_result.severity	從變更記錄對應
msg	security_result.description	從變更記錄對應
protocol	network.application_protocol	從變更記錄對應

變更記錄

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

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