收集 ForgeRock OpenAM 記錄

剖析器版本：4.0

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

ForgeRock OpenAM 是一項存取權管理解決方案，可針對驗證事件、存取控管決策、工作階段活動和設定變更產生系統記錄訊息。剖析器會從 JSON 格式的稽核記錄擷取欄位，並對應至 Unified Data Model (UDM)。

事前準備

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

• Google SecOps 執行個體
• Windows Server 2016 以上版本，或搭載 systemd 的 Linux 主機
• Bindplane 代理程式與 ForgeRock OpenAM 伺服器之間的網路連線
• 如果是在 Proxy 後方執行，請確認防火牆通訊埠已按照 Bindplane 代理程式規定開啟
• AM 控制台的管理員存取權 (例如 amAdmin)

取得 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/openam:
      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: OPENAM
      raw_log_field: body
  
  service:
    pipelines:
      logs/openam_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/openam
  

設定參數

請替換下列預留位置：

• 接收器設定：

  • 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。

舊版 Ingestion API 匯出工具

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

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

設定 ForgeRock OpenAM 的系統記錄處理常式

1. 以管理員身分 (例如 amAdmin) 登入 AM 控制台。
2. 如要在全域設定中建立事件處理常式，請依序前往「設定」>「全域服務」>「稽核記錄」。
   • 如要在領域中建立事件處理常式，請依序前往「領域」>「領域名稱」>「服務」>「稽核記錄」。
3. 依序點選「新增次要設定」>「系統記錄」。
4. 提供下列設定詳細資料：
   • 「Name」(名稱)：輸入事件處理常式的名稱 (例如 Syslog Event Handler)。
   • 伺服器主機名稱：輸入 Bindplane 代理程式 IP 位址。
   • 伺服器通訊埠：輸入 Bindplane 代理程式通訊埠編號 (例如 UDP 的 514)。
   • 「傳輸通訊協定」：選取「UDP」。
   • 連線逾時：輸入連線秒數 (例如 120)。
   • 選用：啟用「緩衝」選項。
5. 點選「建立」。
6. 在「General Handler Configuration」(一般處理常式設定) 分頁中，選取「Enabled」(已啟用) 啟用事件處理常式。
7. 選取稽核記錄的主題：
   • 存取權
   • 活動
   • 驗證
   • 設定
8. 按一下 [儲存]。
9. 在「Syslog Configuration」分頁中，提供下列設定詳細資料：
   • 伺服器主機名稱：輸入 Bindplane IP 位址。
   • Server port：輸入 Bindplane 通訊埠編號。
   • 連線逾時：輸入連線秒數 (例如 120)。
   • 「傳輸通訊協定」：選取「UDP」。
   • Facility：選取「Local0」。
   • 所有主題的嚴重性都會設為「INFORMATIONAL」。
10. 按一下 [儲存]。
11. 在「緩衝」分頁中，選取「啟用緩衝」。
12. 按一下 [儲存]。

UDM 對應表

記錄欄位	UDM 對應	邏輯
client.ip	principal.ip	傳送要求的用戶端 IP 位址。
client.ip	principal.asset.ip	提出要求的用戶端資產 IP 位址。
client.port	principal.port	提出要求的用戶端所使用的連接埠。
entries[0].info.authLevel	principal.resource.resource_subtype	與事件相關聯的驗證等級。開頭為「authLevel:」。
entries[0].info.displayName	security_result.description	驗證樹狀結構中節點的描述性名稱。
entries[0].info.ipAddress	principal.asset.ip	與事件中的主體相關聯的 IP 位址。
entries[0].info.ipAddress	principal.ip	與事件中主體相關聯的 IP 位址。
entries[0].info.nodeId	principal.resource.id	驗證樹狀結構中節點的專屬 ID。前置字串為「nodeId:」。
entries[0].info.nodeOutcome	principal.resource.attribute.labels.value	驗證樹狀結構中節點的結果。
entries[0].info.nodeType	principal.resource.type	驗證樹狀結構中的節點類型。前置字串為「nodeType:」。
entries[0].info.treeName	principal.resource.name	驗證樹狀結構的名稱。開頭為「treeName:」。
eventName	metadata.product_event_type	OpenAM 記錄中的原始事件名稱。
http.request.headers.host[0]	target.asset.hostname	目標伺服器的主機名稱，從 host 標頭擷取。
http.request.headers.host[0]	target.hostname	目標伺服器的主機名稱，從 host 標頭擷取。
http.request.headers.user-agent[0]	network.http.user_agent	HTTP 要求的 user-agent。
http.request.method	network.http.method	要求中使用的 HTTP 方法。
http.request.path	target.url	HTTP 要求網址的路徑。
info.failureReason	security_result.summary	驗證失敗的原因。硬式編碼為「SSO」。由 eventName 和其他欄位的邏輯決定。可以是 GENERIC_EVENT、USER_LOGIN、USER_LOGOUT、NETWORK_HTTP 或 STATUS_UPDATE。硬式編碼為「OPENAM」。硬式編碼為「OpenAM」。硬式編碼為「ForgeRock」。
principal	target.user.userid	事件中涉及的使用者 ID，可從 userId、principal 或 runAs 欄位擷取。
result	security_result.action_details	事件結果 (例如「SUCCESSFUL」、「FAILED」)。
response.detail.reason	security_result.summary	存取結果事件失敗的原因。
response.status	security_result.action_details	存取結果事件中的回覆狀態。
runAs	target.user.userid	事件涉及的使用者 ID，擷取自 userId、principal 或 runAs 欄位。
security_result.action	security_result.action	因安全性事件而採取的動作 (例如「ALLOW」、「BLOCK」)。
server.ip	target.asset.ip	目標伺服器的 IP 位址。
server.ip	target.ip	目標伺服器的 IP 位址。
server.port	target.port	目標伺服器的通訊埠。
timestamp	metadata.event_timestamp	事件的時間戳記。
trackingIds	metadata.product_log_id	與事件相關聯的追蹤 ID。
transactionId	metadata.product_deployment_id	與事件相關聯的交易 ID。
userId	target.user.userid	事件涉及的使用者 ID，擷取自 userId、principal 或 runAs 欄位。
userId	target.user.group_identifiers	與使用者相關聯的群組 ID。
am_group	target.user.group_identifiers	與使用者相關聯的群組 ID。
am_user	target.user.email_addresses	使用者的電子郵件地址 (如有顯示在 am_user 欄位中)。
loginID[0]	target.user.userid	活動中使用的登入 ID。
loginID[0]	target.user.email_addresses	登入時使用的電子郵件地址 (如有)loginID。
hostip	intermediary.hostname	中介裝置的主機名稱。
hostip	intermediary.ip	中介裝置的 IP 位址。
src_ip	principal.asset.ip	來源 IP 位址。
src_ip	principal.ip	來源 IP 位址。
desc	metadata.description	活動說明。
payload	metadata.description	事件的酬載。
http.request.headers.host.0	tatget.hostname	從變更記錄對應
http.request.headers.user-agent.0	network.http.user_agent	從變更記錄對應
extensions.auth.type	SSO	從變更記錄對應

變更記錄

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

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