收集 SAP SuccessFactors 記錄
本文說明如何使用 Google Cloud Storage V2,將 SAP SuccessFactors 記錄檔擷取至 Google Security Operations。
SAP SuccessFactors 是雲端式人力資本管理 (HCM) 平台,可管理核心人資程序、人才管理、薪資和員工分析。系統會產生使用者活動、驗證和稽核追蹤記錄,可使用 OData API 收集。
事前準備
請確認您已完成下列事前準備事項:
- Google SecOps 執行個體
- 已啟用 Cloud Storage API 的 GCP 專案
- 建立及管理 GCS bucket 的權限
- 管理 Google Cloud Storage 值區 IAM 政策的權限
- 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
- 具備管理員權限的 SAP SuccessFactors 特殊存取權
- 為租戶啟用 SAP SuccessFactors OData API 存取權
- SAP SuccessFactors API 伺服器網址 (例如
api15.sapsf.com)
建立 Google Cloud Storage bucket
- 前往 Google Cloud 控制台。
- 選取專案或建立新專案。
- 在導覽選單中,依序前往「Cloud Storage」>「Bucket」。
- 按一下「建立值區」。
請提供下列設定詳細資料:
設定 值 為 bucket 命名 輸入全域不重複的名稱 (例如 sap-successfactors-logs)位置類型 根據需求選擇 (區域、雙區域、多區域) 位置 選取位置 (例如 us-central1)儲存空間級別 標準 (建議用於經常存取的記錄) 存取控管 統一 (建議) 保護工具 選用:啟用物件版本管理或資料保留政策 點選「建立」。
收集 SAP SuccessFactors API 憑證
判斷 API 伺服器網址
SAP SuccessFactors API 伺服器網址取決於您的資料中心。常見的 API 伺服器網址:
| 資料中心 | API 伺服器網址 |
|---|---|
| DC2 (阿姆斯特丹) | https://api2.successfactors.eu |
| DC4 (雪梨) | https://api4.successfactors.com |
| DC8 (法蘭克福) | https://api8.successfactors.com |
| DC10 (美國東部) | https://api10.successfactors.com |
| DC12 (上海) | https://api012.successfactors.cn |
| DC15 (美國西部) | https://api15.sapsf.com |
| DC17 (新加坡) | https://api17.sapsf.com |
| DC19 (阿拉伯聯合大公國) | https://api19.sapsf.com |
建立 API 使用者憑證
- 以管理員身分登入 SAP SuccessFactors。
- 前往管理中心 > 管理權限角色。
- 建立或選取包含下列權限的角色:
- 管理稽核記錄:讀取稽核資料的存取權
- OData API:存取 OData API 端點
- 前往「管理中心」>「管理使用者」。
- 建立技術使用者,或選取現有使用者進行 API 整合。
- 將權限角色指派給使用者。
請記下下列憑證:
- 使用者名稱:SAP SuccessFactors 使用者 ID (格式:
USERNAME@COMPANY_ID) - 密碼:使用者的密碼
- 公司 ID:您的 SAP SuccessFactors 公司 ID
- 使用者名稱:SAP SuccessFactors 使用者 ID (格式:
驗證權限
如要確認帳戶是否具備必要權限,請按照下列步驟操作:
- 登入 SAP SuccessFactors。
- 前往管理中心 > 稽核記錄。
- 如果可以查看稽核記錄資料和匯出選項,表示您具備必要權限。
- 如果沒有看到這個選項,請聯絡 SAP 管理員,授予「管理稽核記錄」權限。
測試 API 存取權
請先測試憑證,再繼續進行整合:
# Replace with your actual credentials SF_USER="USERNAME@COMPANY_ID" SF_PASSWORD="your-password" API_SERVER="https://api15.sapsf.com" # Test API access - fetch audit trail metadata curl -v -u "${SF_USER}:${SF_PASSWORD}" \ "${API_SERVER}/odata/v2/AuditTrail?\$top=1&\$format=json"
為 Cloud Run 函式建立服務帳戶
Cloud Run 函式需要具備 GCS bucket 寫入權限,且可由 Pub/Sub 叫用的服務帳戶。
建立服務帳戶
- 在 GCP 控制台中,依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
- 按一下「Create Service Account」(建立服務帳戶)。
- 請提供下列設定詳細資料:
- 服務帳戶名稱:輸入
sap-sf-logs-collector-sa - 服務帳戶說明:輸入
Service account for Cloud Run function to collect SAP SuccessFactors logs
- 服務帳戶名稱:輸入
- 按一下「建立並繼續」。
- 在「將專案存取權授予這個服務帳戶」部分,新增下列角色:
- 按一下「選擇角色」。
- 搜尋並選取「Storage 物件管理員」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Run Invoker」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)。
- 按一下「繼續」。
- 按一下 [完成]。
這些角色適用於:
- Storage 物件管理員:將記錄檔寫入 GCS bucket,並管理狀態檔案
- Cloud Run 叫用者:允許 Pub/Sub 叫用函式
- Cloud Functions 叫用者:允許函式叫用
授予 GCS 值區的 IAM 權限
將 GCS bucket 的寫入權限授予服務帳戶:
- 依序前往「Cloud Storage」>「Buckets」。
- 點按 bucket 名稱 (例如
sap-successfactors-logs)。 - 前往「權限」分頁標籤。
- 按一下「授予存取權」。
- 請提供下列設定詳細資料:
- 新增主體:輸入服務帳戶電子郵件地址 (例如
sap-sf-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com) - 指派角色:選取「Storage 物件管理員」
- 新增主體:輸入服務帳戶電子郵件地址 (例如
- 按一下 [儲存]。
建立 Pub/Sub 主題
建立 Pub/Sub 主題,Cloud Scheduler 會將訊息發布至該主題,而 Cloud Run 函式會訂閱該主題。
- 在 GCP Console 中,前往「Pub/Sub」>「Topics」(主題)。
- 按一下「建立主題」。
- 請提供下列設定詳細資料:
- 主題 ID:輸入
sap-sf-logs-trigger - 其他設定保留預設值
- 主題 ID:輸入
- 點選「建立」。
建立 Cloud Run 函式來收集記錄
Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發,從 SAP SuccessFactors OData API 擷取記錄,並寫入 GCS。
- 前往 GCP Console 的「Cloud Run」。
- 按一下「Create service」(建立服務)。
- 選取「函式」 (使用內嵌編輯器建立函式)。
在「設定」部分,提供下列設定詳細資料:
設定 值 服務名稱 sap-sf-logs-collector區域 選取與 GCS bucket 相符的區域 (例如 us-central1)執行階段 選取 Python 3.12 以上版本 在「Trigger (optional)」(觸發條件 (選用)) 專區:
- 按一下「+ 新增觸發條件」。
- 選取「Cloud Pub/Sub」。
- 在「選取 Cloud Pub/Sub 主題」中,選擇主題
sap-sf-logs-trigger。 - 按一下 [儲存]。
在「Authentication」(驗證) 部分:
- 選取「需要驗證」。
- 檢查 Identity and Access Management (IAM)。
展開「Containers, Networking, Security」(容器、網路、安全性)。
前往「安全性」分頁:
- 服務帳戶:選取服務帳戶
sap-sf-logs-collector-sa。
- 服務帳戶:選取服務帳戶
前往「容器」分頁:
- 按一下「變數與密鑰」。
- 針對每個環境變數,按一下「+ 新增變數」:
變數名稱 範例值 說明 GCS_BUCKETsap-successfactors-logsGCS bucket 名稱 GCS_PREFIXsf-logs記錄檔的前置字串 STATE_KEYsf-logs/state.json狀態檔案路徑 SF_API_SERVERhttps://api15.sapsf.comSAP SuccessFactors API 伺服器網址 SF_USERNAMEUSERNAME@COMPANY_IDSAP SuccessFactors 使用者名稱 SF_PASSWORDyour-passwordSAP SuccessFactors 密碼 MAX_RECORDS5000每次執行的記錄數上限 PAGE_SIZE1000每頁記錄數 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 import time import base64 # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) # Initialize Storage client storage_client = storage.Client() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'sf-logs') STATE_KEY = os.environ.get('STATE_KEY', 'sf-logs/state.json') SF_API_SERVER = os.environ.get('SF_API_SERVER') SF_USERNAME = os.environ.get('SF_USERNAME') SF_PASSWORD = os.environ.get('SF_PASSWORD') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch SAP SuccessFactors audit logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, SF_API_SERVER, SF_USERNAME, SF_PASSWORD]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) # Overlap by 2 minutes to catch any delayed events last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Fetch logs records, newest_event_time = fetch_logs( api_server=SF_API_SERVER, username=SF_USERNAME, password=SF_PASSWORD, start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) if not records: print("No new log records found.") save_state(bucket, STATE_KEY, now.isoformat()) return # Write to GCS as NDJSON timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) 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}") # Update state with newest event time if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing logs: {str(e)}') raise def load_state(bucket, key): """Load state from GCS.""" try: blob = bucket.blob(key) if blob.exists(): state_data = blob.download_as_text() return json.loads(state_data) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, key, last_event_time_iso: str): """Save the last event timestamp to GCS state file.""" try: state = {'last_event_time': last_event_time_iso} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_time={last_event_time_iso}") except Exception as e: print(f"Warning: Could not save state: {e}") def fetch_logs(api_server: str, username: str, password: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch audit trail logs from SAP SuccessFactors OData API with pagination and rate limiting. Args: api_server: SAP SuccessFactors API server URL username: SAP SuccessFactors username (USERNAME@COMPANY_ID) password: SAP SuccessFactors password start_time: Start time for log query end_time: End time for log query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (records list, newest_event_time ISO string) """ base_url = api_server.rstrip('/') # Build Basic Auth header auth_string = f"{username}:{password}" auth_bytes = auth_string.encode('utf-8') auth_b64 = base64.b64encode(auth_bytes).decode('utf-8') headers = { 'Authorization': f'Basic {auth_b64}', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-SAPSFCollector/1.0' } records = [] newest_time = None page_num = 0 backoff = 1.0 skip = 0 # Format datetime for OData filter start_str = start_time.strftime("%Y-%m-%dT%H:%M:%S") end_str = end_time.strftime("%Y-%m-%dT%H:%M:%S") while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break remaining = min(page_size, max_records - len(records)) url = ( f"{base_url}/odata/v2/AuditTrail" f"?$filter=changedDate ge datetime'{start_str}' and changedDate le datetime'{end_str}'" f"&$top={remaining}" f"&$skip={skip}" f"&$format=json" ) try: response = http.request('GET', url, headers=headers) # Handle rate limiting with exponential backoff if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429). Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue backoff = 1.0 if response.status != 200: print(f"HTTP Error: {response.status}") response_text = response.data.decode('utf-8') print(f"Response body: {response_text}") return [], None data = json.loads(response.data.decode('utf-8')) # OData response structure page_results = data.get('d', {}).get('results', []) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} events") records.extend(page_results) # Track newest event time for event in page_results: try: changed_date = event.get('changedDate', '') # OData datetime format: /Date(1234567890000)/ if changed_date and changed_date.startswith('/Date('): ms = int(changed_date.split('(')[1].split(')')[0].split('+')[0].split('-')[0]) event_dt = datetime.fromtimestamp(ms / 1000, tz=timezone.utc) event_time = event_dt.isoformat() if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") # Check for more results if len(page_results) < remaining: print(f"Reached last page (size={len(page_results)} < limit={remaining})") break skip += len(page_results) except Exception as e: print(f"Error fetching logs: {e}") return [], None print(f"Retrieved {len(records)} total records from {page_num} pages") return records, newest_time第二個檔案 requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
點選「部署」即可儲存並部署函式。
等待部署作業完成 (2 到 3 分鐘)。
建立 Cloud Scheduler 工作
Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題,觸發 Cloud Run 函式。
- 前往 GCP 主控台的「Cloud Scheduler」。
- 點選「建立工作」。
請提供下列設定詳細資料:
設定 值 名稱 sap-sf-logs-collector-hourly區域 選取與 Cloud Run 函式相同的區域 頻率 0 * * * *(每小時整點)時區 選取時區 (建議使用世界標準時間) 目標類型 Pub/Sub 主題 選取主題 sap-sf-logs-trigger郵件內文 {}(空白 JSON 物件)點選「建立」。
排程頻率選項
根據記錄檔量和延遲時間要求選擇頻率:
| 頻率 | Cron 運算式 | 用途 |
|---|---|---|
| 每 5 分鐘 | */5 * * * * |
大量、低延遲 |
| 每 15 分鐘 | */15 * * * * |
中等 |
| 每小時 | 0 * * * * |
標準 (建議) |
| 每 6 小時 | 0 */6 * * * |
少量、批次處理 |
| 每日 | 0 0 * * * |
歷來資料集合 |
測試整合項目
- 在 Cloud Scheduler 控制台中找出您的工作。
- 按一下「強制執行」即可手動觸發工作。
- 稍等幾秒鐘。
- 前往「Cloud Run」>「Services」。
- 按一下
sap-sf-logs-collector。 - 按一下 [Logs] (記錄) 分頁標籤。
確認函式是否已順利執行。請注意以下事項:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X events Wrote X records to gs://sap-successfactors-logs/sf-logs/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X records依序前往「Cloud Storage」>「Buckets」。
按一下 bucket 名稱 (
sap-successfactors-logs)。前往
sf-logs/資料夾。確認是否已建立新的
.ndjson檔案,且檔案名稱包含目前的時間戳記。
如果記錄中顯示錯誤: - HTTP 401:檢查環境變數中的 API 憑證 - HTTP 403:確認帳戶在 SAP SuccessFactors 中具有必要權限 - HTTP 429:速率限制 - 函式會自動重試並延遲 - 缺少環境變數:檢查是否已設定所有必要變數
在 Google SecOps 中設定資訊提供,擷取 SAP SuccessFactors 記錄
- 依序前往「SIEM 設定」>「動態饋給」。
- 按一下「新增動態消息」。
- 按一下「設定單一動態饋給」。
- 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如
SAP SuccessFactors Logs)。 - 選取「Google Cloud Storage V2」做為「來源類型」。
- 選取「SAP SuccessFactors」做為「記錄類型」。
按一下「取得服務帳戶」,系統會顯示專屬服務帳戶電子郵件地址,例如:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com複製這個電子郵件地址。
點選「下一步」。
指定下列輸入參數的值:
儲存空間 bucket URL:輸入 GCS bucket URI,並加上前置路徑:
gs://sap-successfactors-logs/sf-logs/- 取代:
sap-successfactors-logs:您的 GCS bucket 名稱。sf-logs:儲存記錄的選用前置字元/資料夾路徑 (如為根目錄,請留空)。
- 取代:
來源刪除選項:根據偏好設定選取刪除選項:
- 永不:移轉後一律不刪除任何檔案 (建議用於測試)。
- 刪除已轉移的檔案:成功轉移檔案後刪除檔案。
刪除已轉移的檔案和空白目錄:成功轉移後刪除檔案和空白目錄。
檔案存在時間上限:包含在過去天數內修改的檔案 (預設為 180 天)
資產命名空間:資產命名空間
擷取標籤:要套用至這個動態饋給事件的標籤
點選「下一步」。
在「Finalize」(完成) 畫面中檢查新的動態饋給設定,然後按一下「Submit」(提交)。
將 IAM 權限授予 Google SecOps 服務帳戶
Google SecOps 服務帳戶需要 GCS bucket 的「Storage 物件檢視者」角色。
- 依序前往「Cloud Storage」>「Buckets」。
- 點按 bucket 名稱。
- 前往「權限」分頁標籤。
- 按一下「授予存取權」。
- 請提供下列設定詳細資料:
- 新增主體:貼上 Google SecOps 服務帳戶電子郵件地址
- 指派角色:選取「Storage 物件檢視者」
- 按一下 [儲存]。
UDM 對應表
| 記錄欄位 | UDM 對應 | 邏輯 |
|---|---|---|
| module、functional_area、functional_sub_area、context_1_value、context_2_value、context_3_value、context_4_value、context_5_value、new_value、old_value、operation_performed、effective_start_date、effective_sequence | additional.fields | 從每個欄位建立權杖,並在欄位不為空白且符合條件時合併 |
| changed_by_user_first_name | intermediary_1.user.first_name | 如果值不為空且有次要使用者,則直接複製值 |
| changed_by_user_last_name | intermediary_1.user.last_name | 如果值不為空且有次要使用者,則直接複製值 |
| changed_by_user_username | intermediary_1.user.userid | 如果值不為空且有次要使用者,則直接複製值 |
| proxy_user_first_name | intermediary_2.user.first_name | 如果值不是空白,則直接複製 |
| proxy_user_last_name | intermediary_2.user.last_name | 如果值不是空白,則直接複製 |
| proxy_user_username | intermediary_2.user.userid | 如果值不是空白,則直接複製 |
| metadata.event_type | 設為「GENERIC_EVENT」,如果 context_1_key ==「Role」或 field_name ==「Role」,則會覆寫為「USER_RESOURCE_ACCESS」,如果主體使用者欄位存在且 changed_by_user_username 不存在,則會覆寫為「RESOURCE_PERMISSIONS_CHANGE」 | |
| new_value | permission.name | 如果 field_name ==「Permission」,則從 new_value 複製的值 |
| secondary_user_email | principal.user.email_addresses | 如果值不是空白,則直接複製 |
| secondary_user_provisioner_id | principal.user.userid | 如果值不是空白,則直接複製 |
| context_1_value、new_value | role.name | 如果 context_1_key ==「Role」,則為 context_1_value;如果 field_name ==「Role name」或「Role」,則為 new_value |
| old_value、new_value | target.group.attribute.labels | 根據 field_name 與 old_value 或 new_value 中的權杖合併 |
| context_1_value、new_value | target.group.group_display_name | 如果 context_1_key ==「Group」,則為 context_1_value 的值;否則,如果 field_name ==「Group」或「Group name」,則為 new_value 的值 |
| context_3_value | target.resource.name | 如果 context_3_key ==「Feature Name」,則從 context_3_value 複製的值 |
| context_2_value | target.resource.product_object_id | 如果 context_2_key ==「Feature Id」,則從 context_2_value 複製的值 |
| old_value、new_value | target.user.attribute.labels | 根據 field_name 與 old_value 或 new_value 中的權杖合併 |
| new_value | target.user.attribute.permissions | 如果 field_name ==「Permission」,則會與從 new_value 建立的權限物件合併 |
| context_1_value、new_value | target.user.attribute.roles | 如果 context_1_key ==「Role」,則與從 context_1_value 建立的角色物件合併;如果 field_name ==「Role name」或「Role」,則與從 new_value 建立的角色物件合併 |
| subject_user_first_name、first_name、first_name | target.user.first_name | 如果 subject_user_first_name 不為空,則使用該值;否則,如果 context_1_key ==「Proxy Rights For」,則使用 grok 從 context_1_value 擷取;否則,如果 context_2_key ==「User name」,則使用 grok 從 context_2_value 擷取 |
| subject_user_last_name、last_name、last_name | target.user.last_name | 如果 subject_user_last_name 不為空值,則為該值;否則,如果 context_1_key ==「Proxy Rights For」,則使用 grok 從 context_1_value 擷取;否則,如果 context_2_key ==「User name」,則使用 grok 從 context_2_value 擷取 |
| subject_user_id、context_1_value | target.user.userid | 如果 subject_user_id 不為空值,則為該值;否則,如果 context_1_key ==「User」,則為 context_1_value |
| metadata.product_name | 設為「SuccessFactors」 | |
| metadata.vendor_name | 設為「SAP」 |
變更記錄
還有其他問題嗎?向社群成員和 Google SecOps 專業人員尋求答案。