收集 CloudM 記錄
剖析器版本:6.0
本文說明如何使用 Google Cloud Storage V2,將 CloudM 記錄擷取至 Google Security Operations。
CloudM 是適用於 Google Workspace 和 Microsoft 365 的 SaaS 平台,可自動執行使用者加入和離職程序、資料備份、封存和遷移作業。CloudM Automate 會產生網域中所有動作的完整稽核記錄,包括使用者管理事件、離職工作流程步驟、設定變更和安全性相關作業。系統會保留過去一年的稽核記錄資料。
事前準備
請確認您已完成下列事前準備事項:
- Google SecOps 執行個體
- 已啟用 Cloud Storage API 的 Google Cloud 專案
- 建立及管理 Cloud Storage bucket 的權限
- 管理 Cloud Storage 值區身分與存取權管理 (IAM) 政策的權限
- 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
- 具備「編輯全域設定」權限的 CloudM Automate 執行個體管理員存取權
- CloudM Automate 執行個體網址 (例如
yourcompany.cloudm.io) - CloudM 網域 ID
收集 CloudM Automate 憑證
建立自訂角色,授予 API 記錄存取權
- 登入 CloudM Automate 執行個體。
- 依序前往「設定」>「角色」。
- 按一下「新增角色」建立新角色。
- 在「Role Name」欄位中,輸入描述性名稱 (例如
Google SecOps Log Reader)。 在權限清單中,啟用下列權限:
- 查看記錄:授予查看所有應用程式記錄的權限。
儲存角色。
建立服務帳戶並指派角色
- 在 CloudM Automate 中,依序前往「Settings」>「Roles」。
- 建立或找出用於 API 存取的服務帳戶。
- 將「Google SecOps 記錄讀取者」角色指派給服務帳戶。
- 請務必指派全域範圍的角色,服務帳戶才能存取整個網域的記錄。
取得服務帳戶存取權杖
- 產生服務帳戶的存取權杖。
- 向 CloudM Logs API 發出 API 要求時,存取權杖會做為
Authorization標頭中的不記名權杖。 記錄下列值:
- Automate 執行個體網址:CloudM Automate 執行個體網址 (例如
yourcompany.cloudm.io) - 網域 ID:CloudM 網域 ID
- 服務帳戶存取權杖:用於 API 驗證的 Bearer 權杖
- Automate 執行個體網址:CloudM Automate 執行個體網址 (例如
驗證權限
如要確認帳戶是否具備必要權限,請按照下列步驟操作:
- 登入 CloudM Automate。
- 依序前往「設定」>「角色」。
- 確認服務帳戶已獲派具有全域範圍的「查看記錄」權限。
- 如果沒有看到這個選項,請與管理員聯絡,請對方授予「編輯全域設定」和「查看記錄」權限。
測試 API 存取權
請先測試憑證,再繼續進行整合:
# Replace with your actual credentials CLOUDM_INSTANCE="yourcompany.cloudm.io" DOMAIN_ID="your-domain-id" ACCESS_TOKEN="your-access-token" # Test API access curl -v -H "Authorization: Bearer ${ACCESS_TOKEN}" \ "https://${CLOUDM_INSTANCE}/_ah/api/events/v1/${DOMAIN_ID}?from=$(date -u +%Y-%m-%d)&to=$(date -u +%Y-%m-%d)"成功的回應會傳回稽核記錄事件的 JSON 陣列。
必要的 API 權限
服務帳戶必須具備下列權限:
權限 存取層級 目的 查看記錄 全球 從 CloudM Automate 擷取所有稽核記錄事件
建立 Google Cloud 儲存空間 bucket
- 前往 Google Cloud 控制台。
- 選取專案或建立新專案。
- 在導覽選單中,依序前往「Cloud Storage」>「Bucket」。
- 按一下「建立值區」。
請提供下列設定詳細資料:
設定 值 為 bucket 命名 輸入全域不重複的名稱 (例如 cloudm-audit-logs)位置類型 根據需求選擇 (區域、雙區域、多區域) 位置 選取位置 (例如 us-central1)儲存空間級別 標準 (建議用於經常存取的記錄) 存取控管 統一 (建議) 保護工具 選用:啟用物件版本管理或保留政策 點選「建立」。
為 Cloud Run 函式建立服務帳戶
Cloud Run 函式需要具備 Cloud Storage bucket 寫入權限,且可由 Pub/Sub 叫用的服務帳戶。
建立服務帳戶
- 在 Google Cloud Console 中,依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
- 按一下「Create Service Account」(建立服務帳戶)。
- 提供下列設定詳細資料:
- 服務帳戶名稱:輸入
cloudm-audit-collector-sa - 服務帳戶說明:輸入
Service account for Cloud Run function to collect CloudM audit logs
- 服務帳戶名稱:輸入
- 按一下「建立並繼續」。
在「將專案存取權授予這個服務帳戶」部分,新增下列角色:
- 按一下「選擇角色」。
- 搜尋並選取「Storage 物件管理員」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Run Invoker」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)。
按一下「繼續」。
按一下 [完成]。
這些角色適用於:
- Storage 物件管理員:將記錄檔寫入 Cloud Storage bucket,並管理狀態檔案
- Cloud Run 叫用者:允許 Pub/Sub 叫用函式
- Cloud Functions 叫用者:允許函式叫用
授予 Cloud Storage bucket 的 IAM 權限
授予服務帳戶 Cloud Storage 值區的寫入權限:
- 依序前往「Cloud Storage」>「Buckets」。
- 按一下 bucket 名稱 (
cloudm-audit-logs)。 - 前往「權限」分頁標籤。
- 按一下「授予存取權」。
請提供下列設定詳細資料:
- 新增主體:輸入服務帳戶電子郵件地址 (
cloudm-audit-collector-sa@PROJECT_ID.iam.gserviceaccount.com) - 指派角色:選取「Storage 物件管理員」
- 新增主體:輸入服務帳戶電子郵件地址 (
按一下 [儲存]。
建立 Pub/Sub 主題
建立 Pub/Sub 主題,Cloud Scheduler 會將訊息發布至該主題,而 Cloud Run 函式會訂閱該主題。
- 在 Google Cloud 控制台中,依序前往「Pub/Sub」>「主題」。
- 按一下「建立主題」。
請提供下列設定詳細資料:
- 主題 ID:輸入
cloudm-audit-trigger - 其他設定保留預設值
- 主題 ID:輸入
點選「建立」。
建立 Cloud Run 函式來收集記錄
Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發,從 CloudM Automate Logs API 擷取記錄,並寫入 Cloud Storage。
- 前往 Google Cloud 控制台的「Cloud Run」。
- 按一下「Create service」(建立服務)。
- 選取「函式」 (使用內嵌編輯器建立函式)。
在「設定」部分,提供下列設定詳細資料:
設定 值 服務名稱 cloudm-audit-collector區域 選取與 Cloud Storage bucket 相符的區域 (例如 us-central1)執行階段 選取 Python 3.12 以上版本 在「Trigger (optional)」(觸發條件 (選用)) 專區:
- 按一下「+ 新增觸發條件」。
- 選取「Cloud Pub/Sub」。
- 在「Select a Cloud Pub/Sub topic」(選取 Cloud Pub/Sub 主題) 中,選擇
cloudm-audit-trigger。 - 按一下 [儲存]。
在「Authentication」(驗證) 部分:
- 選取「需要驗證」。
- 檢查 Identity and Access Management (IAM)。
向下捲動並展開「容器」、「網路」和「安全性」。
前往「安全性」分頁:
- 服務帳戶:選取
cloudm-audit-collector-sa
- 服務帳戶:選取
前往「容器」分頁:
- 按一下「變數與密鑰」。
針對每個環境變數,按一下「+ 新增變數」:
變數名稱 範例值 說明 GCS_BUCKETcloudm-audit-logsCloud Storage Bucket 名稱 GCS_PREFIXcloudm-audit記錄檔的前置字串 STATE_KEYcloudm-audit/state.json狀態檔案路徑 CLOUDM_INSTANCE_URLyourcompany.cloudm.ioCloudM Automate 執行個體網址 CLOUDM_DOMAIN_IDyour-domain-idCloudM 網域 ID CLOUDM_ACCESS_TOKENyour-access-tokenCloudM 服務帳戶不記名權杖 LOOKBACK_HOURS24初始回溯期
在「變數與密鑰」部分,向下捲動至「要求」:
- 要求逾時:輸入
600秒 (10 分鐘)
- 要求逾時:輸入
前往「設定」分頁:
在「資源」部分中:
- 記憶體:選取 512 MiB 以上
- CPU:選取 1
在「修訂版本資源調度」部分:
- 執行個體數量下限:輸入
0 - 執行個體數量上限:輸入
100
- 執行個體數量下限:輸入
點選「建立」。
等待服務建立完成 (1 到 2 分鐘)。
服務建立完成後,系統會自動開啟內嵌程式碼編輯器。
新增函式程式碼
- 在「進入點」欄位中輸入「main」。
在內嵌程式碼編輯器中,建立兩個檔案:
main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone, timedelta http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=10.0, read=60.0), retries=False, ) storage_client = storage.Client() GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'cloudm-audit') STATE_KEY = os.environ.get('STATE_KEY', 'cloudm-audit/state.json') CLOUDM_INSTANCE_URL = os.environ.get('CLOUDM_INSTANCE_URL', '').rstrip('/') CLOUDM_DOMAIN_ID = os.environ.get('CLOUDM_DOMAIN_ID') CLOUDM_ACCESS_TOKEN = os.environ.get('CLOUDM_ACCESS_TOKEN') LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) @functions_framework.cloud_event def main(cloud_event): if not all([GCS_BUCKET, CLOUDM_INSTANCE_URL, CLOUDM_DOMAIN_ID, CLOUDM_ACCESS_TOKEN]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) state = load_state(bucket) now = datetime.now(timezone.utc) if isinstance(state, dict) and state.get('last_event_date'): try: last_date = state['last_event_date'] last_time = datetime.strptime(last_date, '%Y-%m-%d').replace(tzinfo=timezone.utc) except Exception as e: print(f"Warning: Could not parse last_event_date: {e}") last_time = now - timedelta(hours=LOOKBACK_HOURS) else: last_time = now - timedelta(hours=LOOKBACK_HOURS) from_date = last_time.strftime('%Y-%m-%d') to_date = now.strftime('%Y-%m-%d') print(f"Fetching logs from {from_date} to {to_date}") records = fetch_logs(from_date, to_date) if not records: print("No new log records found.") save_state(bucket, to_date) return timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/cloudm_audit_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join( [json.dumps(record, ensure_ascii=False, default=str) for record in records] ) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(records)} records to gs://{GCS_BUCKET}/{object_key}") save_state(bucket, to_date) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing logs: {str(e)}') raise def fetch_logs(from_date, to_date): instance = CLOUDM_INSTANCE_URL if not instance.startswith('https://'): instance = f"https://{instance}" endpoint = f"{instance}/_ah/api/events/v1/{CLOUDM_DOMAIN_ID}" headers = { 'Authorization': f'Bearer {CLOUDM_ACCESS_TOKEN}', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-CloudMCollector/1.0' } url = f"{endpoint}?from={from_date}&to={to_date}" try: response = http.request('GET', url, headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', '60')) print(f"Rate limited (429). Retry after {retry_after}s.") return [] if response.status != 200: print(f"HTTP Error: {response.status}") response_text = response.data.decode('utf-8') print(f"Response body: {response_text}") return [] data = json.loads(response.data.decode('utf-8')) if isinstance(data, list): records = data elif isinstance(data, dict): records = data.get('items', data.get('events', [data])) else: records = [] print(f"Retrieved {len(records)} events") return records except Exception as e: print(f"Error fetching logs: {e}") return [] def load_state(bucket): try: blob = bucket.blob(STATE_KEY) if blob.exists(): return json.loads(blob.download_as_text()) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, last_event_date): try: state = { 'last_event_date': last_event_date, 'last_run': datetime.now(timezone.utc).isoformat() } blob = bucket.blob(STATE_KEY) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_date={last_event_date}") except Exception as e: print(f"Warning: Could not save state: {e}")requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
點選「部署」即可儲存並部署函式。
等待部署作業完成 (2 到 3 分鐘)。
建立 Cloud Scheduler 工作
Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題,觸發 Cloud Run 函式。
- 前往 Google Cloud 控制台的「Cloud Scheduler」。
- 點選「建立工作」。
請提供下列設定詳細資料:
設定 值 名稱 cloudm-audit-collector-hourly區域 選取與 Cloud Run 函式相同的區域 頻率 0 * * * *(每小時整點)時區 選取時區 (建議使用世界標準時間) 目標類型 Pub/Sub 主題 選取「 cloudm-audit-trigger」郵件內文 {}(空白 JSON 物件)點選「建立」。
測試整合項目
- 在 Cloud Scheduler 控制台中,找出您的工作 (
cloudm-audit-collector-hourly)。 - 按一下「強制執行」即可手動觸發工作。
- 稍等幾秒鐘。
- 前往「Cloud Run」>「Services」。
- 按一下
cloudm-audit-collector。 - 按一下 [Logs] (記錄) 分頁標籤。
確認函式是否已順利執行。尋找:
Fetching logs from YYYY-MM-DD to YYYY-MM-DD Retrieved X events Wrote X records to gs://cloudm-audit-logs/cloudm-audit/cloudm_audit_YYYYMMDD_HHMMSS.ndjson Successfully processed X records依序前往「Cloud Storage」>「Buckets」。
按一下
cloudm-audit-logs。前往
cloudm-audit/資料夾。確認是否已建立新的
.ndjson檔案,且檔案名稱包含目前的時間戳記。
如果記錄中顯示錯誤:
- HTTP 401:確認
CLOUDM_ACCESS_TOKEN環境變數是否正確。 - HTTP 403:確認服務帳戶是否具備全域範圍的「查看記錄」權限。
- HTTP 429:頻率限制,函式會停止,並在下次排定的執行時間恢復。
- 缺少環境變數:確認 Cloud Run 函式設定中已設定所有必要變數
擷取 Google SecOps 服務帳戶
Google SecOps 會使用專屬服務帳戶,從 Cloud Storage 值區讀取資料。您必須授予這個服務帳戶值區存取權。
取得服務帳戶電子郵件地址
- 依序前往「SIEM 設定」>「動態饋給」。
- 按一下「新增動態消息」。
- 按一下「設定單一動態饋給」。
- 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如
CloudM Audit Logs)。 - 選取「Google Cloud Storage V2」做為「來源類型」。
- 選取「CloudM」做為「記錄類型」。
按一下「取得服務帳戶」。
系統會顯示專屬服務帳戶電子郵件地址,例如:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com複製這個電子郵件地址,以便在下一步中使用。
點選「下一步」。
指定下列輸入參數的值:
儲存空間 bucket URL:輸入 Cloud Storage bucket URI,並加上前置路徑:
gs://cloudm-audit-logs/cloudm-audit/來源刪除選項:根據偏好設定選取刪除選項:
- 永不:移轉後一律不刪除任何檔案 (建議用於測試)。
- 刪除已轉移的檔案:成功轉移檔案後刪除檔案。
刪除已轉移的檔案和空白目錄:成功轉移後刪除檔案和空白目錄。
檔案存在時間上限:包含在過去天數內修改的檔案 (預設為 180 天)。
資產命名空間:資產命名空間。
擷取標籤:要套用至這個動態饋給事件的標籤。
點選「下一步」。
在「Finalize」(完成) 畫面中檢查新的動態饋給設定,然後按一下「Submit」(提交)。
將 IAM 權限授予 Google SecOps 服務帳戶
Google SecOps 服務帳戶必須具備 Cloud Storage bucket 的「Storage 物件檢視者」角色。
- 依序前往「Cloud Storage」>「Buckets」。
- 按一下
cloudm-audit-logs。 - 前往「權限」分頁標籤。
- 按一下「授予存取權」。
請提供下列設定詳細資料:
- 新增主體:貼上 Google SecOps 服務帳戶電子郵件地址
- 指派角色:選取「Storage 物件檢視者」
按一下 [儲存]。
CloudM Logs API 參數
CloudM Logs API 支援下列查詢參數,可篩選記錄事件:
| 參數 | 格式 | 說明 |
|---|---|---|
| byUser | 電子郵件地址 | 依執行動作的使用者篩選事件 (類似於 CloudM UI 中的「使用者」) |
| 來自 | yyyy-MM-dd |
日期範圍篩選器的開始日期 |
| 到 | yyyy-MM-dd |
日期範圍篩選器的結束日期 |
| contextType | 字串 | 依內容類型篩選 (例如設定檔、群組、機構單位) |
| contextName | 字串 | 依動作目標篩選 (例如特定使用者離職) |
| 作業 | 字串 | 依作業類型篩選 (例如指派別名、暫停使用者) |
| country | 國家/地區代碼 | 依地理位置國家/地區代碼篩選 |
UDM 對應表
| 記錄欄位 | UDM 對應 | 邏輯 |
|---|---|---|
| 關於 | 關於 | 直接複製值 |
| Context_Name | about.labels | 從 about_Context_Name、about_Context_Type、labels0 合併為鍵/值組合 |
| Context_Type | about.labels | |
| Login_Type | about.labels | |
| 核發單位 | additional.fields | 已從 additional_field0、additional_field1、additional_field2 合併 |
| SAML_code | additional.fields | |
| SAML_ACS_Url | additional.fields | |
| 作業 | extensions.auth.type | 如果作業與 SSORequest 相符,則設為 SSO;如果 Context_Type 為 LoginUser,則設為 AUTHTYPE_UNSPECIFIED |
| Context_Type | extensions.auth.type | |
| 時間戳記 | metadata.event_timestamp | 從時間戳記擷取日期時間和時區,將時區轉換為偏移量,串連並剖析為時間戳記 |
| 作業 | metadata.event_type | 如果 Operation 符合 Update/Delete/SuspendUser/UnsuspendUser/Create,則設為 USER_UNCATEGORIZED;如果 Operation 符合 SSORequest/SSORequestFail 或 Context_Type 為 LoginUser,則設為 USER_LOGIN;如果 IP 不為空白,則設為 STATUS_UPDATE;否則設為 GENERIC_EVENT |
| Context_Type | metadata.event_type | |
| User_Agent | network.http.user_agent | 直接複製值 |
| 主體 | 主體 | 如果 Context_Type != LoginUser,則從主體重新命名,否則從目標重新命名 |
| 目標 | 主體 | |
| Organization_Unit | principal.administrative_domain | 直接複製值 |
| IP | principal.ip | 直接複製值 |
| 城市 | principal.location.city | 直接複製值 |
| 國家/地區 | principal.location.country_or_region | 直接複製值 |
| 地理位置 | principal.location.region_latitude | 使用 grok 從 Geolocation 擷取的緯度 |
| 地理位置 | principal.location.region_longitude | 使用 grok 從 Geolocation 擷取的經度 |
| 區域 | principal.location.state | 直接複製值 |
| 執行者 | principal.user.attribute.roles | 如果 Actor 不是電子郵件且不為空白,則設為 role.name,然後合併 |
| 執行者 | principal.user.email_addresses | 如果執行者符合電子郵件規則運算式,則直接複製值 |
| 訊息 | principal.user.userid | 使用 grok 從 Message 擷取的使用者名稱 |
| security_result | security_result | 合併 security_result 物件 |
| SAML_code | security_result.action | 如果 SAML_code 符合 Success,請設為 ALLOW;如果為 RequestDenied,請設為 BLOCK |
| 訊息 | security_result.description | 直接複製值 |
| 嚴重性 | security_result.severity | 如果為 Error/Critical,請設為大寫;如果為 Info,請設為 INFORMATIONAL;如果為 Warning,請設為 MEDIUM;否則請設為 UNKNOWN_SEVERITY |
| 作業 | security_result.summary | 直接複製值 |
| 目標 | 目標 | 如果 Context_Type != LoginUser,則從目標重新命名,否則從主體重新命名 |
| 主體 | 目標 | |
| metadata.product_name | metadata.product_name | 設為「CLOUDM」 |
| metadata.vendor_name | metadata.vendor_name | 設為「CLOUDM」 |
變更記錄
還有其他問題嗎?向社群成員和 Google SecOps 專業人員尋求解答。