收集 OpenCanary 記錄

支援的服務:

這個剖析器會從 OpenCanary SYSLOG 和 JSON 記錄擷取欄位、正規化為 UDM 格式,並使用 metadata.event_type 和 security_result.severity 等衍生欄位擴充資料。可處理各種記錄格式、驗證 IP 位址,並將欄位對應至適當的 UDM 物件,例如 principal、target 和 network。

事前準備

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

  • Google SecOps 執行個體。
  • OpenCanary 的特殊存取權。

設定動態饋給

如要設定動態饋給,請按照下列步驟操作:

  1. 依序前往「設定」>「資料管理」>「動態饋給」。如果使用的是 SIEM 專用平台,請依序前往「設定」>「動態饋給」。
  2. 按一下「新增動態饋給」。
  3. 在下一頁,點按「設定單一動態饋給」。
  4. 在「Feed name」(動態饋給名稱) 欄位中輸入動態饋給名稱,例如 OpenCanary Logs。
  5. 「Source type」(來源類型) 請選取「Webhook」。
  6. 選取「OpenCanary」做為「記錄類型」。
  7. 點選「下一步」。
  8. 選用:指定下列輸入參數的值:
    • 分割分隔符號:用於分隔記錄行的分隔符號,例如 \n。
  9. 點選「下一步」。
  10. 在「完成」畫面中檢查動態饋給設定,然後按一下「提交」。
  11. 按一下「產生密鑰」,產生用於驗證這個動態饋給的密鑰。
  12. 複製並儲存密鑰。您無法再次查看這個 Secret Key。如有需要,您可以重新產生新的密鑰,但這項操作會使先前的密鑰失效。
  13. 在「詳細資料」分頁中,複製「端點資訊」欄位中的動態饋給端點網址。您必須在用戶端應用程式中指定這個端點網址。
  14. 按一下「完成」。

為 Webhook 動態饋給建立 API 金鑰

  1. 依序前往 Google Cloud 控制台 >「憑證」。

    前往「憑證」

  2. 按一下 [Create credentials] (建立憑證),然後選取 [API key] (API 金鑰)。

  3. 限制 API 金鑰存取 Google Security Operations API。

指定端點網址

  1. 在用戶端應用程式中,指定 Webhook 動態饋給提供的 HTTPS 端點網址。
  2. 如要啟用驗證功能,請在自訂標頭中指定 API 金鑰和密鑰,格式如下:

    X-goog-api-key = API_KEY
    X-Webhook-Access-Key = SECRET
    

    建議:將 API 金鑰指定為標頭,而非在網址中指定。

  3. 如果 Webhook 用戶端不支援自訂標頭,您可以使用查詢參數指定 API 金鑰和密鑰,格式如下:

    ENDPOINT_URL?key=API_KEY&secret=SECRET
    

    更改下列內容:

    • ENDPOINT_URL:動態饋給端點網址。
    • API_KEY:用於向 Google Security Operations 驗證身分的 API 金鑰。
    • SECRET:您產生的密鑰,用於驗證動態饋給。

設定 Google SecOps 的 OpenCanary Webhook

  1. 找出 OpenCanary 設定檔 config.json。

  2. 使用文字編輯器開啟 config.json 檔案。

  3. 在設定檔中找到標示為 alerters 的部分。

  4. 如果已有 webhook 警示器,請加以修改。否則,請為 webhook 警示器新增項目。

  5. 請使用下列設定 (將 ENDPOINT_URL、SECRET 和 API_KEY 替換為您的值):

"handlers": {
    "Webhook": {
        "class": "opencanary.logger.WebhookHandler",
        "url": "<ENDPOINT_URL>",
        "method": "POST",
        "data": {"message": "%(message)s"},
        "status_code": 200,
        "headers": {
            "X-Webhook-Access-Key": "<SECRET>",
            "X-goog-api-key": "<API_KEY>"
         }
    }
}
  1. 儲存 config.json 檔案。
  2. 重新啟動 OpenCanary 服務,套用變更。(例如 sudo systemctl restart opencanary)。

UDM 對應表

記錄欄位 UDM 對應 邏輯
dst_host target.asset.ip 原始記錄的 dst_host 欄位會對應至 UDM。也對應到 target.ip。
dst_host target.ip 原始記錄的 dst_host 欄位會對應至 UDM。也對應到 target.asset.ip。
dst_port target.port 原始記錄的 dst_port 欄位會先轉換為字串,再轉換為整數,並對應至 UDM。
local_time metadata.event_timestamp 原始記錄的 local_time 欄位會用於填入 UDM 中的 metadata.event_timestamp。如果沒有 local_time 欄位,剖析器會使用批次物件中的 create_time。
local_time_adjusted security_result.detection_fields 原始記錄的 local_time_adjusted 欄位會以鍵/值組合的形式,新增至 UDM 的 security_result.detection_fields 陣列。
logdata.COMMUNITY_STRING security_result.detection_fields 原始記錄的 logdata.COMMUNITY_STRING 欄位會以鍵/值組合的形式,新增至 UDM 的 security_result.detection_fields 陣列。
logdata.DOMAIN principal.administrative_domain 原始記錄的 logdata.DOMAIN 欄位會對應至 UDM。
logdata.FILENAME target.file.full_path 原始記錄的 logdata.FILENAME 欄位會對應至 UDM。
logdata.HOSTNAME principal.asset.hostname 如果 logdata.HOSTNAME 欄位不是 IP 位址,則會對應至 UDM。也對應到 principal.hostname。
logdata.HOSTNAME principal.asset.ip 如果 logdata.HOSTNAME 欄位是 IP 位址,則會對應至 UDM。也對應到 principal.ip。
logdata.HOSTNAME principal.hostname 如果 logdata.HOSTNAME 欄位不是 IP 位址,則會對應至 UDM。也對應到 principal.asset.hostname。
logdata.HOSTNAME principal.ip 如果 logdata.HOSTNAME 欄位是 IP 位址,則會對應至 UDM。也對應到 principal.asset.ip。
logdata.LOCALNAME principal.asset.hostname 原始記錄的 logdata.LOCALNAME 欄位會對應至 UDM。也對應到 principal.hostname。
logdata.LOCALNAME principal.hostname 原始記錄的 logdata.LOCALNAME 欄位會對應至 UDM。也對應到 principal.asset.hostname。
logdata.LOCALVERSION principal.platform_version 原始記錄的 logdata.LOCALVERSION 欄位會對應至 UDM。
logdata.PASSWORD extensions.auth.mechanism logdata.PASSWORD 欄位存在時,剖析器會將 UDM 中的 extensions.auth.mechanism 設為 USERNAME_PASSWORD。
logdata.PATH network.http.referral_url 原始記錄的 logdata.PATH 欄位會對應至 UDM。
logdata.REMOTENAME target.asset.hostname 原始記錄的 logdata.REMOTENAME 欄位會對應至 UDM。也對應到 target.hostname。
logdata.REMOTENAME target.hostname 原始記錄的 logdata.REMOTENAME 欄位會對應至 UDM。也對應到 target.asset.hostname。
logdata.REMOTEVERSION target.platform_version 原始記錄的 logdata.REMOTEVERSION 欄位會對應至 UDM。
logdata.SMBVER network.application_protocol logdata.SMBVER 欄位存在時,剖析器會將 UDM 中的 network.application_protocol 設為 SMB。
logdata.USERAGENT network.http.parsed_user_agent 原始記錄的 logdata.USERAGENT 欄位會轉換為剖析的使用者代理程式,並對應至 UDM。
logdata.USERAGENT network.http.user_agent 原始記錄的 logdata.USERAGENT 欄位會對應至 UDM。
logdata.USERNAME target.user.userid 原始記錄的 logdata.USERNAME 欄位會對應至 UDM。
loglevel security_result.severity 原始記錄的 loglevel 欄位會決定 UDM 中的 security_result.severity。WARNING 對應至 HIGH,INFO/INFORMATION 對應至 LOW。
logtype security_result.detection_fields 原始記錄的 logtype 欄位會以鍵/值組合的形式,新增至 UDM 的 security_result.detection_fields 陣列。
node_id principal.asset.asset_id 原始記錄的 node_id 欄位會加上「id:」前置字元,並對應至 UDM。
src_host principal.asset.ip 原始記錄的 src_host 欄位會對應至 UDM。也對應到 principal.ip。
src_host principal.ip 原始記錄的 src_host 欄位會對應至 UDM。也對應到 principal.asset.ip。
src_port principal.port 原始記錄的 src_port 欄位會轉換為整數,並對應至 UDM。
utc_time security_result.detection_fields 原始記錄的 utc_time 欄位會以鍵/值組合的形式,新增至 UDM 的 security_result.detection_fields 陣列。

變更記錄

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

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