收集 ForgeRock OpenAM 記錄
剖析器版本:4.0
本文說明如何使用 Bindplane 代理程式,將 ForgeRock OpenAM 記錄擷取至 Google Security Operations。
ForgeRock OpenAM 是一項存取權管理解決方案,可針對驗證事件、存取權控管決策、工作階段活動和設定變更產生系統記錄訊息。剖析器會從 JSON 格式的稽核記錄中擷取欄位,並對應至統合式資料模型 (UDM)。
事前準備
請確認您已完成下列事前準備事項:
- Google SecOps 執行個體
- Windows Server 2016 以上版本,或搭載
systemd的 Linux 主機 - Bindplane 代理程式與 ForgeRock OpenAM 伺服器之間的網路連線
- 如果透過 Proxy 執行,請確保防火牆通訊埠已根據 Bindplane 代理程式需求開啟
- AM 控制台的管理員存取權 (例如
amAdmin)
取得 Google SecOps 擷取驗證檔案
- 登入 Google SecOps 控制台。
- 依序前往「SIEM 設定」>「收集代理程式」。
- 下載擷取驗證檔案。
將檔案安全地儲存在要安裝 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 安裝
- 開啟具有根層級或 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服務應顯示為有效 (執行中)。
其他安裝資源
如需其他安裝選項和疑難排解資訊,請參閱 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/openam: compression: gzip creds_file_path: '/etc/bindplane-agent/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.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是標準的系統記錄通訊埠 (在 Linux 上需要根層級權限;非根層級權限請使用1514)
匯出工具設定:
creds_file_path:擷取驗證檔案的完整路徑:- Linux:
/etc/bindplane-agent/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
customer_id:從 Google SecOps 控制台複製的客戶 IDendpoint:區域端點網址:- 美國:
malachiteingestion-pa.googleapis.com - 歐洲:
europe-malachiteingestion-pa.googleapis.com - 亞洲:
asia-southeast1-malachiteingestion-pa.googleapis.com - 如需完整清單,請參閱「區域端點」
- 美國:
儲存設定檔
- 編輯完成後,請儲存檔案:
- 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"
- 按下
設定 ForgeRock OpenAM 的系統記錄處理常式
- 以管理員身分登入 AM 控制台 (例如 amAdmin)。
- 如要在全域設定中建立事件處理常式,請依序前往「設定」>「全域服務」>「稽核記錄」。
- 如要在領域中建立事件處理常式,請依序前往「領域」>「領域名稱」>「服務」>「稽核記錄」。
- 依序點選「Add a Secondary Configuration」>「Syslog」。
- 提供下列設定詳細資料:
- 名稱:輸入事件處理常式的名稱 (例如
Syslog Event Handler)。 - 伺服器主機名稱:輸入 Bindplane 代理程式 IP 位址。
- 伺服器通訊埠:輸入 Bindplane 代理程式通訊埠編號 (例如 UDP 的
514)。 - 「傳輸通訊協定」:選取「UDP」。
- 連線逾時:輸入連線秒數 (例如
120)。 - 選用:啟用「緩衝」選項。
- 名稱:輸入事件處理常式的名稱 (例如
- 點選「建立」。
- 在「一般處理常式設定」分頁中,選取「已啟用」,即可啟用事件處理常式。
- 選取稽核記錄的主題:
- 存取
- 活動
- 驗證
- 設定
- 按一下 [儲存]。
- 在「Syslog Configuration」(系統記錄設定) 分頁中,提供下列設定詳細資料:
- 伺服器主機名稱:輸入 Bindplane IP 位址。
- 伺服器通訊埠:輸入 Bindplane 通訊埠號碼。
- 連線逾時:輸入連線秒數 (例如
120)。 - 「傳輸通訊協定」:選取「UDP」。
- 設施:選取「Local0」。
- 所有主題的嚴重程度都設為「資訊」。
- 按一下 [儲存]。
- 在「緩衝」分頁中,選取「已啟用緩衝」即可啟用。
- 按一下 [儲存]。
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 |
事件中涉及的 User-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 |
事件中涉及的 User-ID,可從 userId、principal 或 runAs 欄位擷取。 |
security_result.action |
security_result.action |
因應安全性事件而採取的動作 (例如「允許」、「封鎖」)。 |
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 |
事件中涉及的 User-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 專業人員尋求解答。