收集 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 存储桶的权限
  • 管理 GCS 存储桶的 IAM 政策的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 拥有管理员权限，可对 Saviynt EIP 进行特权访问

创建 Google Cloud Storage 存储桶

  1. 前往 Google Cloud 控制台。
  2. 选择您的项目或创建一个新项目。
  3. 在导航菜单中，前往 Cloud Storage > 存储桶。
  4. 点击创建存储分区。

  5. 提供以下配置详细信息：

    设置 值
    指定存储桶的名称 输入一个全局唯一的名称（例如 saviynt-eip-logs）
    位置类型 根据您的需求进行选择（区域级、双区域级、多区域级）
    位置 选择位置（例如 us-central1）
    存储类别 标准（建议用于频繁访问的日志）
    访问权限控制 统一（推荐）
    保护工具 可选：启用对象版本控制或保留政策

  6. 点击创建。

收集 Saviynt EIP API 凭据

获取 API 凭据

  1. 登录 Saviynt EIP 管理控制台。
  2. 依次前往管理 > 设置 > 连接。
  3. 创建或确定具有以下权限的 API 用户：
    • webservice_api_authenticateUser
    • api_v5_fetchRuntimeControlsData
  4. 请注意以下细节：
    • 用户名：API 用户账号的用户名。
    • 密码：API 用户账号密码。
    • Saviynt 主机网址：您的 Saviynt 租户网址（例如 https://YOUR_SAVIYNT_HOST）。

确定 Google 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 存储桶和被 Pub/Sub 调用的权限。

创建服务账号

  1. 在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
  2. 点击创建服务账号。
  3. 提供以下配置详细信息：
    • 服务账号名称：输入 saviynt-eip-collector-sa。
    • 服务账号说明：输入 Service account for Cloud Run function to collect Saviynt EIP logs。
  4. 点击创建并继续。
  5. 在向此服务账号授予对项目的访问权限部分，添加以下角色：
    1. 点击选择角色。
    2. 搜索并选择 Storage Object Admin。
    3. 点击 + 添加其他角色。
    4. 搜索并选择 Cloud Run Invoker。
    5. 点击 + 添加其他角色。
    6. 搜索并选择 Cloud Functions Invoker。
  6. 点击继续。
  7. 点击完成。

以下操作需要这些角色：

  • Storage Object Admin：将日志写入 GCS 存储桶并管理状态文件
  • Cloud Run Invoker：允许 Pub/Sub 调用函数
  • Cloud Functions Invoker：允许调用函数

授予对 GCS 存储桶的 IAM 权限

向服务账号授予对 GCS 存储桶的写入权限：

  1. 前往 Cloud Storage > 存储桶。
  2. 点击您的存储桶名称（例如 saviynt-eip-logs）。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：输入服务账号电子邮件地址（例如 saviynt-eip-collector-sa@your-project.iam.gserviceaccount.com）。
    • 分配角色：选择 Storage Object Admin。
  6. 点击保存。

创建 Pub/Sub 主题

创建一个 Pub/Sub 主题，供 Cloud Scheduler 发布消息，并供 Cloud Run 函数订阅。

  1. 在 GCP 控制台中，前往 Pub/Sub > 主题。
  2. 点击创建主题。
  3. 提供以下配置详细信息：
    • 主题 ID：输入 saviynt-eip-trigger。
    • 将其他设置保留为默认值。
  4. 点击创建。

创建 Cloud Run 函数以收集日志

Cloud Run 函数将由来自 Cloud Scheduler 的 Pub/Sub 消息触发，以从 Saviynt EIP API 中提取日志并将其写入 GCS。

  1. 在 GCP 控制台中，前往 Cloud Run。
  2. 点击创建服务。
  3. 选择函数（使用内嵌编辑器创建函数）。

  4. 在配置部分中，提供以下配置详细信息：

    设置 值
    Service 名称 saviynt-eip-collector
    区域 选择与您的 GCS 存储桶匹配的区域（例如 us-central1）
    运行时 选择 Python 3.12 或更高版本

  5. 在触发器（可选）部分中：

    1. 点击 + 添加触发器。
    2. 选择 Cloud Pub/Sub。
    3. 在选择 Cloud Pub/Sub 主题中，选择主题 saviynt-eip-trigger。
    4. 点击保存。

  6. 在身份验证部分中：

    1. 选择需要进行身份验证。
    2. 检查 Identity and Access Management (IAM)。

  7. 向下滚动并展开容器、网络、安全性。

  8. 前往安全标签页：

    • 服务账号：选择服务账号 saviynt-eip-collector-sa。

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击 + 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET saviynt-eip-logs GCS 存储桶名称
    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 分析记录名称
    TIMEFRAME_MINUTES 60 每个查询的时间范围（以分钟为单位）
    MAX_RECORDS 10000 每次运行的记录数上限
    LOOKBACK_HOURS 24 初始回溯期

  10. 在变量和 Secret 标签页中，前往请求部分：

    • 请求超时：输入 600 秒（10 分钟）。

  11. 前往容器中的设置标签页：

    • 在资源部分中：
      • 内存：选择 512 MiB 或更高值。
      • CPU：选择 1。

  12. 在修订版本伸缩部分中：

    • 实例数下限：输入 0。
    • 实例数上限：输入 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 * * * *（每小时整点）
    时区 选择时区（建议选择世界协调时间 [UTC]）
    目标类型 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 > 服务 > saviynt-eip-collector > 日志。

  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 中配置 Feed 以注入 Saviynt EIP 日志

  1. 前往 SIEM 设置 > Feed。
  2. 点击添加新 Feed。
  3. 点击配置单个 Feed。
  4. 在 Feed 名称字段中，输入 Feed 的名称（例如 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. 为以下输入参数指定值：

    • 存储桶网址：输入带有前缀路径的 GCS 存储桶 URI：

      gs://saviynt-eip-logs/saviynt/
      • 替换：
        • saviynt-eip-logs：您的 GCS 存储桶名称。
        • saviynt：存储日志的可选前缀/文件夹路径（留空表示根目录）。

    • 来源删除选项：根据您的偏好选择删除选项：

      • 永不：转移后永不删除任何文件（建议用于测试）。
      • 删除已转移的文件：成功转移后删除文件。

      • 删除已转移的文件和空目录：成功转移后删除文件和空目录。

    • 文件存在时间上限：包含在过去指定天数内修改过的文件（默认值为 180 天）。

    • 资产命名空间：资产命名空间。

    • 注入标签：要应用于此 Feed 中的事件的标签。

  11. 点击下一步。

  12. 在最终确定界面中查看新的 Feed 配置，然后点击提交。

向 Google SecOps 服务账号授予 IAM 权限

Google SecOps 服务账号需要您的 GCS 存储桶的 Storage Object Viewer 角色。

  1. 前往 Cloud Storage > 存储桶。
  2. 点击您的存储桶名称 (saviynt-eip-logs)。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：粘贴 Google SecOps 服务账号邮箱。
    • 分配角色：选择 Storage Object Viewer。

  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
action_taken sr.action_details 操作详情
类别 sr.category_details 类别详情
消息、消息 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 专业人士的解答。