收集 Saviynt Enterprise Identity Cloud 記錄

支援的國家/地區：

本文說明如何使用 Google Cloud Storage V2，將 Saviynt Enterprise Identity Cloud (EIP) 記錄檔擷取至 Google Security Operations。

Saviynt Enterprise Identity Cloud (EIP) 是身分治理和雲端安全平台，用於存取權管理、身分生命週期管理和法規遵循。這個平台會為身分資源庫中執行的所有安全活動產生稽核記錄資料。

事前準備

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

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage API 的 GCP 專案
  • 建立及管理 GCS bucket 的權限
  • 管理 Google Cloud Storage 值區 IAM 政策的權限
  • 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • 具備管理員權限，可存取 Saviynt EIP

建立 Google Cloud Storage bucket

  1. 前往 Google Cloud 控制台。
  2. 選取專案或建立新專案。
  3. 在導覽選單中，依序前往「Cloud Storage」>「Bucket」。
  4. 按一下「建立值區」。

  5. 請提供下列設定詳細資料：

    設定 值
    為 bucket 命名 輸入全域不重複的名稱 (例如 saviynt-eip-logs)
    位置類型 根據需求選擇 (區域、雙區域、多區域)
    位置 選取位置 (例如 us-central1)
    儲存空間級別 標準 (建議用於經常存取的記錄)
    存取控管 統一 (建議)
    保護工具 選用：啟用物件版本管理或資料保留政策

  6. 點選「建立」。

收集 Saviynt EIP API 憑證

取得 API 憑證

  1. 登入 Saviynt EIP 管理控制台。
  2. 依序前往「管理」>「設定」>「連線」。
  3. 建立或找出具有下列權限的 API 使用者：
    • webservice_api_authenticateUser
    • api_v5_fetchRuntimeControlsData
  4. 請注意下列詳細資料：
    • 使用者名稱：API 使用者帳戶的使用者名稱。
    • 「Password」(密碼)：API 使用者帳戶密碼。
    • Saviynt 主機網址：您的 Saviynt 租戶網址 (例如 https://YOUR_SAVIYNT_HOST)。

決定 Analytics 名稱

  1. 在 Saviynt 管理控制台中，依序前往「Admin」>「Runtime Controls」。
  2. 記下要匯出稽核資料的 Analytics 名稱 (例如 AuditTrailAnalytics)。

驗證權限

如要確認 API 使用者是否具備必要權限，請按照下列步驟操作：

  1. 登入 Saviynt EIP 管理控制台。
  2. 依序前往「管理」>「使用者管理」。
  3. 按一下 API 使用者帳戶。
  4. 確認使用者具備 webservice_api_authenticateUser 和 api_v5_fetchRuntimeControlsData 存取權。
  5. 如果缺少權限，請與 Saviynt 管理員聯絡。

測試 API 存取權

  • 請先測試憑證，再繼續進行整合：

    # Replace with your actual credentials
SAVIYNT_HOST="https://YOUR_SAVIYNT_HOST"
USERNAME="your-username"
PASSWORD="your-password"

# Get authentication token
TOKEN=$(curl -s -X POST "${SAVIYNT_HOST}/ECM/api/login" \
  -H "Content-Type: application/json" \
  -d "{\"username\": \"${USERNAME}\", \"password\": \"${PASSWORD}\"}" \
  | jq -r '.access_token')

# Test API access
curl -v -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/json" \
  -X POST "${SAVIYNT_HOST}/ECM/api/v5/fetchRuntimeControlsDataV2" \
  -d '{"analyticsname": "YOUR_ANALYTICS_NAME", "timeFrame": 5}'

為 Cloud Run 函式建立服務帳戶

Cloud Run 函式需要具備 GCS bucket 寫入權限，且可由 Pub/Sub 叫用的服務帳戶。

建立服務帳戶

  1. 在 GCP 控制台中，依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  2. 按一下「Create Service Account」(建立服務帳戶)。
  3. 請提供下列設定詳細資料：
    • 服務帳戶名稱：輸入 saviynt-eip-collector-sa。
    • 服務帳戶說明：輸入 Service account for Cloud Run function to collect Saviynt EIP logs。
  4. 按一下「建立並繼續」。
  5. 在「將專案存取權授予這個服務帳戶」部分，新增下列角色：
    1. 按一下「選擇角色」。
    2. 搜尋並選取「Storage 物件管理員」。
    3. 點選「+ 新增其他角色」。
    4. 搜尋並選取「Cloud Run Invoker」。
    5. 點選「+ 新增其他角色」。
    6. 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)。
  6. 按一下「繼續」。
  7. 按一下 [完成]。

這些角色適用於：

  • Storage 物件管理員：將記錄檔寫入 GCS bucket，並管理狀態檔案
  • Cloud Run 叫用者：允許 Pub/Sub 叫用函式
  • Cloud Functions 叫用者：允許函式叫用

授予 GCS 值區的 IAM 權限

將 GCS bucket 的寫入權限授予服務帳戶：

  1. 依序前往「Cloud Storage」>「Buckets」。
  2. 按一下 bucket 名稱 (例如 saviynt-eip-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：輸入服務帳戶電子郵件地址 (例如 saviynt-eip-collector-sa@your-project.iam.gserviceaccount.com)。
    • 指派角色：選取「Storage 物件管理員」。
  6. 按一下 [儲存]。

建立 Pub/Sub 主題

建立 Pub/Sub 主題，Cloud Scheduler 會將訊息發布至該主題，而 Cloud Run 函式會訂閱該主題。

  1. 在 GCP Console 中，前往「Pub/Sub」>「Topics」(主題)。
  2. 按一下「建立主題」。
  3. 請提供下列設定詳細資料：
    • 主題 ID：輸入 saviynt-eip-trigger。
    • 其他設定保留預設值。
  4. 點選「建立」。

建立 Cloud Run 函式來收集記錄

Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發，從 Saviynt EIP API 擷取記錄，並寫入 GCS。

  1. 前往 GCP Console 的「Cloud Run」。
  2. 按一下「Create service」(建立服務)。
  3. 選取「函式」 (使用內嵌編輯器建立函式)。

  4. 在「設定」部分，提供下列設定詳細資料：

    設定 值
    服務名稱 saviynt-eip-collector
    區域 選取與 GCS bucket 相符的區域 (例如 us-central1)
    執行階段 選取 Python 3.12 以上版本

  5. 在「Trigger (optional)」(觸發條件 (選用)) 專區：

    1. 按一下「+ 新增觸發條件」。
    2. 選取「Cloud Pub/Sub」。
    3. 在「選取 Cloud Pub/Sub 主題」中，選擇主題 saviynt-eip-trigger。
    4. 按一下 [儲存]。

  6. 在「Authentication」(驗證) 部分：

    1. 選取「需要驗證」。
    2. 檢查 Identity and Access Management (IAM)。

  7. 向下捲動並展開「容器」、「網路」和「安全性」。

  8. 前往「安全性」分頁：

    • 服務帳戶：選取服務帳戶 saviynt-eip-collector-sa。

  9. 前往「容器」分頁：

    1. 按一下「變數與密鑰」。
    2. 針對每個環境變數，按一下「+ 新增變數」：
    變數名稱 範例值 說明
    GCS_BUCKET saviynt-eip-logs GCS bucket 名稱
    GCS_PREFIX saviynt 記錄檔的前置字串
    STATE_KEY saviynt/state.json 狀態檔案路徑
    SAVIYNT_HOST https://YOUR_SAVIYNT_HOST Saviynt 租戶網址
    SAVIYNT_USER your-api-username API 使用者名稱
    SAVIYNT_PASS your-api-password API 使用者密碼
    ANALYTICS_NAME AuditTrailAnalytics Analytics 記錄名稱
    TIMEFRAME_MINUTES 60 每項查詢的時間範圍 (以分鐘為單位)
    MAX_RECORDS 10000 每次執行的記錄數上限
    LOOKBACK_HOURS 24 初始回溯期

  10. 在「變數與密鑰」分頁中，前往「要求」部分：

    • 要求逾時：輸入 600 秒 (10 分鐘)。

  11. 前往「容器」中的「設定」分頁：

    • 在「資源」部分：
      • 記憶體：選取 512 MiB 以上。
      • CPU：選取 1。

  12. 在「修訂版本資源調度」部分：

    • 執行個體數量下限：輸入 0。
    • 「Maximum number of instances」(執行個體數量上限)：輸入 100 (或根據預期負載調整)。

  13. 點選「建立」。

  14. 等待服務建立完成 (1 到 2 分鐘)。

  15. 服務建立完成後，系統會自動開啟內嵌程式碼編輯器。

新增函式程式碼

  1. 在「函式進入點」中輸入 main。

  2. 在內嵌程式碼編輯器中建立兩個檔案：

    • 第一個檔案 main.py:

      import functions_framework
from google.cloud import storage
import json
import os
import urllib3
from datetime import datetime, timezone, timedelta
import time

# 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', 'saviynt')
STATE_KEY = os.environ.get('STATE_KEY', 'saviynt/state.json')
SAVIYNT_HOST = os.environ.get('SAVIYNT_HOST', '').rstrip('/')
SAVIYNT_USER = os.environ.get('SAVIYNT_USER', '')
SAVIYNT_PASS = os.environ.get('SAVIYNT_PASS', '')
ANALYTICS_NAME = os.environ.get('ANALYTICS_NAME', '')
TIMEFRAME_MINUTES = int(os.environ.get('TIMEFRAME_MINUTES', '60'))
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000'))
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)

def get_token():
  """Get authentication token from Saviynt login API."""
  login_url = f"{SAVIYNT_HOST}/ECM/api/login"

  body = json.dumps({
    "username": SAVIYNT_USER,
    "password": SAVIYNT_PASS
  })

  headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  }

  backoff = 1.0
  max_retries = 3

  for attempt in range(max_retries):
    response = http.request('POST', login_url, body=body.encode('utf-8'), headers=headers)

    if response.status == 429:
      retry_after = int(response.headers.get('Retry-After', str(int(backoff))))
      print(f"Rate limited (429) on login request. Retrying after {retry_after}s...")
      time.sleep(retry_after)
      backoff = min(backoff * 2, 30.0)
      continue

    if response.status != 200:
      raise RuntimeError(f"Failed to authenticate: {response.status} - {response.data.decode('utf-8')}")

    data = json.loads(response.data.decode('utf-8'))
    return data['access_token']

  raise RuntimeError(f"Failed to get token after {max_retries} retries due to rate limiting")

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch Saviynt EIP logs and write to GCS.

  Args:
    cloud_event: CloudEvent object containing Pub/Sub message
  """

  if not all([GCS_BUCKET, SAVIYNT_HOST, SAVIYNT_USER, SAVIYNT_PASS, ANALYTICS_NAME]):
    print('Error: Missing required environment variables')
    return

  try:
    bucket = storage_client.bucket(GCS_BUCKET)

    # Load state
    state = load_state(bucket, STATE_KEY)

    now = datetime.now(timezone.utc)

    print(f"Fetching audit logs with analytics={ANALYTICS_NAME}, timeFrame={TIMEFRAME_MINUTES}")

    # Get access token
    token = get_token()

    # Fetch logs
    records = fetch_logs(
      token=token,
      analytics_name=ANALYTICS_NAME,
      timeframe_minutes=TIMEFRAME_MINUTES,
      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}")

    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(token: str, analytics_name: str, timeframe_minutes: int, max_records: int):
  """
  Fetch audit logs from Saviynt fetchRuntimeControlsDataV2 API with rate limiting.

  Args:
    token: Authentication token
    analytics_name: Name of the analytics record
    timeframe_minutes: Timeframe in minutes for the query
    max_records: Maximum total records to fetch

  Returns:
    List of records
  """
  endpoint = f"{SAVIYNT_HOST}/ECM/api/v5/fetchRuntimeControlsDataV2"

  headers = {
    'Authorization': f'Bearer {token}',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'User-Agent': 'GoogleSecOps-SaviyntCollector/1.0'
  }

  body = json.dumps({
    "analyticsname": analytics_name,
    "timeFrame": timeframe_minutes
  })

  backoff = 1.0
  max_retries = 3

  for attempt in range(max_retries):
    try:
      response = http.request('POST', endpoint, body=body.encode('utf-8'), headers=headers)

      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 []

      data = json.loads(response.data.decode('utf-8'))

      # Saviynt returns results in a 'result' or 'results' key
      records = data.get('result', data.get('results', []))

      if isinstance(records, list):
        if len(records) > max_records:
          records = records[:max_records]
        print(f"Retrieved {len(records)} audit records")
        return records
      else:
        # If the response is a single object, wrap it
        print(f"Retrieved 1 audit record")
        return [records]

    except Exception as e:
      print(f"Error fetching logs: {e}")
      if attempt < max_retries - 1:
        time.sleep(backoff)
        backoff = min(backoff * 2, 30.0)
        continue
      return []

  return []

    • 第二個檔案 requirements.txt:

      functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

  3. 點選「部署」即可儲存並部署函式。

  4. 等待部署作業完成 (2 到 3 分鐘)。

建立 Cloud Scheduler 工作

Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題，觸發 Cloud Run 函式。

  1. 前往 GCP 主控台的「Cloud Scheduler」。
  2. 點選「建立工作」。

  3. 請提供下列設定詳細資料：

    設定 值
    名稱 saviynt-eip-collector-hourly
    區域 選取與 Cloud Run 函式相同的區域
    頻率 0 * * * * (每小時整點)
    時區 選取時區 (建議使用世界標準時間)
    目標類型 Pub/Sub
    主題 選取主題 saviynt-eip-trigger
    郵件內文 {} (空白 JSON 物件)

  4. 點選「建立」。

排程頻率選項

根據記錄檔量和延遲時間要求選擇頻率：

頻率 Cron 運算式 用途
每 5 分鐘 */5 * * * * 大量、低延遲
每 15 分鐘 */15 * * * * 中等
每小時 0 * * * * 標準 (建議)
每 6 小時 0 */6 * * * 少量、批次處理
每日 0 0 * * * 歷來資料集合

測試整合項目

  1. 在 Cloud Scheduler 控制台中，找出您的工作 (saviynt-eip-collector-hourly)。
  2. 按一下「強制執行」即可手動觸發。
  3. 等待幾秒鐘，然後依序前往「Cloud Run」>「Services」>「saviynt-eip-collector」>「Logs」。

  4. 確認函式是否已順利執行。請注意以下事項：

    Fetching audit logs with analytics=AuditTrailAnalytics, timeFrame=60
Retrieved X audit records
Wrote X records to gs://saviynt-eip-logs/saviynt/logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

  5. 檢查 GCS 值區 (saviynt-eip-logs)，確認記錄是否已寫入。

如果記錄中顯示錯誤：

  • HTTP 401：檢查環境變數中的 API 憑證
  • HTTP 403：確認 API 使用者在 Saviynt 管理控制台中具備必要權限
  • HTTP 429：頻率限制 - 函式會自動重試，並延遲一段時間
  • 驗證失敗：確認 SAVIYNT_HOST、SAVIYNT_USER 和 SAVIYNT_PASS 正確無誤

在 Google SecOps 中設定動態饋給，擷取 Saviynt EIP 記錄

  1. 依序前往「SIEM 設定」>「動態饋給」。
  2. 按一下「新增動態消息」。
  3. 按一下「設定單一動態饋給」。
  4. 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如 Saviynt EIP Logs)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」。
  6. 選取「Saviynt Enterprise Identity Cloud」做為「記錄類型」。

  7. 按一下「取得服務帳戶」，系統會顯示專屬服務帳戶電子郵件地址，例如：

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com

  8. 複製這個電子郵件地址，後續步驟會用到。

  9. 點選「下一步」。

  10. 指定下列輸入參數的值：

    • 儲存空間 bucket URL：輸入 GCS bucket URI，並加上前置路徑：

      gs://saviynt-eip-logs/saviynt/
      • 取代：
        • saviynt-eip-logs：您的 GCS bucket 名稱。
        • saviynt：儲存記錄的選用前置字元/資料夾路徑 (如為根目錄，請留空)。

    • 來源刪除選項：根據偏好設定選取刪除選項：

      • 永不：移轉後一律不刪除任何檔案 (建議用於測試)。
      • 刪除已轉移的檔案：成功轉移檔案後刪除檔案。

      • 刪除已轉移的檔案和空白目錄：成功轉移後刪除檔案和空白目錄。

    • 檔案存在時間上限：包含在過去天數內修改的檔案 (預設為 180 天)。

    • 資產命名空間：資產命名空間。

    • 擷取標籤：要套用至這個動態饋給事件的標籤。

  11. 點選「下一步」。

  12. 在「Finalize」(完成) 畫面中檢查新的動態饋給設定，然後按一下「Submit」(提交)。

將 IAM 權限授予 Google SecOps 服務帳戶

Google SecOps 服務帳戶需要 GCS bucket 的「Storage 物件檢視者」角色。

  1. 依序前往「Cloud Storage」>「Buckets」。
  2. 按一下 bucket 名稱 (saviynt-eip-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：貼上 Google SecOps 服務帳戶電子郵件地址。
    • 指派角色：選取「Storage 物件檢視者」。

  6. 按一下 [儲存]。

UDM 對應表

記錄欄位 UDM 對應 邏輯
action_taken sr.action_details 動作詳細資料
category sr.category_details 類別詳細資料
Message,message metadata.description 事件說明
metadata.event_type 活動類型
物件類型 metadata.product_event_type 產品專屬事件類型
eventId metadata.product_log_id 產品記錄 ID
IP 位址 principal.ip IP 位址
查詢 principal.process.command_line 程序的指令列
actionUri principal.url 網址
accessed_by principal.user.email_addresses 使用者的電子郵件地址
accessed_by principal.user.userid 使用者 ID
sr security_result 安全性結果
metadata.product_name 產品名稱
metadata.vendor_name 供應商名稱

變更記錄

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

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