收集 Kyriba Treasury Management 日志

支持的平台：

本文档介绍了如何使用 Google Cloud Storage V2 将 Kyriba 资金管理日志注入到 Google Security Operations。

Kyriba 是一个基于云的财务和金融管理平台。它会针对付款操作、用户访问、审批工作流和金融交易生成审核日志。解析器从 Kyriba 审核数据中提取字段，并将其映射到统一数据模型 (UDM)，从而捕获用户身份、交易详情、审批状态和安全结果。

准备工作

请确保满足以下前提条件：

  • Google SecOps 实例
  • 启用了 Cloud Storage API 的 GCP 项目
  • 创建和管理 GCS 存储桶的权限
  • 管理 GCS 存储桶的 IAM 政策的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 对 Kyriba 平台拥有特权访问权限，有权配置 API 访问权限并生成 OAuth2 凭据

创建 Google Cloud Storage 存储桶

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

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

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

  6. 点击创建。

收集 Kyriba API 凭据

获取 Kyriba 实例网址

  1. 登录您的 Kyriba 平台。
  2. 记下浏览器地址栏中的实例网址。
    • 格式：https://<your-instance>.kyriba.com
    • 示例：如果您通过 https://acme.kyriba.com/gateway 访问 Kyriba，则您的实例网址为 https://acme.kyriba.com

创建 OAuth2 API 凭据

  1. 以管理员身份登录 Kyriba 平台。
  2. 依次前往管理 > API 访问权限。
  3. 点击创建或添加应用。
  4. 提供以下配置详细信息：
    • 应用名称：输入 Google Security Operations Integration
    • 授权类型：选择客户端凭据
  5. 点击保存。

  6. 复制并妥善保存凭据：

    • 客户端 ID：复制此值
    • 客户端密钥：复制此值

验证权限

如需验证凭据是否具有所需的权限，请执行以下操作：

  1. 登录 Kyriba 平台。
  2. 依次前往管理 > API 访问权限。
  3. 确认您创建的应用已列出，且状态为有效。
  4. 验证应用是否具有 Audit Trail API 范围的访问权限。

测试 API 访问权限

  • 在继续进行集成之前，请测试您的凭据：

    # Replace with your actual credentials
CLIENT_ID="<your-client-id>"
CLIENT_SECRET="<your-client-secret>"
KYRIBA_HOST="https://<your-instance>.kyriba.com"

# Get OAuth2 token
TOKEN=$(curl -s -X POST "${KYRIBA_HOST}/gateway/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=${CLIENT_ID}&client_secret=${CLIENT_SECRET}" \
  | python3 -c "import sys,json; print(json.load(sys.stdin)['access_token'])")

# Test API access
curl -v -H "Authorization: Bearer ${TOKEN}" \
  "${KYRIBA_HOST}/gateway/api/v1/audit-trails?startDate=2024-01-01&endDate=2024-01-02"

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个服务账号，该账号具有写入 GCS 存储桶和被 Pub/Sub 调用的权限。

创建服务账号

  1. 在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
  2. 点击创建服务账号。
  3. 提供以下配置详细信息：
    • 服务账号名称：输入 kyriba-logs-collector-sa
    • 服务账号说明：输入 Service account for Cloud Run function to collect Kyriba Treasury Management 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. 点击您的存储桶名称（例如 kyriba-treasury-logs）。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：输入服务账号电子邮件地址（例如 kyriba-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com）
    • 分配角色：选择 Storage Object Admin
  6. 点击保存。

创建 Pub/Sub 主题

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

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

创建 Cloud Run 函数以收集日志

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

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

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

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

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

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

  6. 在身份验证部分中：

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

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

  8. 前往安全标签页：

    • 服务账号：选择服务账号 (kyriba-logs-collector-sa)

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击 + 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET kyriba-treasury-logs GCS 存储桶名称
    GCS_PREFIX kyriba 日志文件的前缀
    STATE_KEY kyriba/state.json 状态文件路径
    KYRIBA_HOST https://<your-instance>.kyriba.com Kyriba 实例网址
    CLIENT_ID your-client-id OAuth2 客户端 ID
    CLIENT_SECRET your-client-secret OAuth2 客户端密钥
    MAX_RECORDS 1000 每次运行的记录数上限
    PAGE_SIZE 100 每页记录数
    LOOKBACK_HOURS 24 初始回溯期

  10. 在变量和密钥部分中，向下滚动到请求：

    • 请求超时：输入 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
  import urllib.parse

  # 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', 'kyriba')
  STATE_KEY = os.environ.get('STATE_KEY', 'kyriba/state.json')
  KYRIBA_HOST = os.environ.get('KYRIBA_HOST')
  CLIENT_ID = os.environ.get('CLIENT_ID')
  CLIENT_SECRET = os.environ.get('CLIENT_SECRET')
  MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '1000'))
  PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100'))
  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_oauth_token(host: str, client_id: str, client_secret: str) -> str:
    """Get OAuth 2.0 access token from Kyriba."""
    token_url = f"{host.rstrip('/')}/gateway/oauth/token"
    data = urllib.parse.urlencode({
      'grant_type': 'client_credentials',
      'client_id': client_id,
      'client_secret': client_secret,
    }).encode('utf-8')
    response = http.request(
      'POST', token_url,
      body=data,
      headers={'Content-Type': 'application/x-www-form-urlencoded'},
    )
    if response.status != 200:
      raise Exception(f"OAuth token request failed: {response.status} {response.data.decode('utf-8')}")
    token_data = json.loads(response.data.decode('utf-8'))
    return token_data['access_token']

  @functions_framework.cloud_event
  def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch Kyriba Treasury Management
    audit logs and write them to GCS.

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

    if not all([GCS_BUCKET, KYRIBA_HOST, CLIENT_ID, CLIENT_SECRET]):
      print('Error: Missing required environment variables')
      return

    try:
      # Get GCS bucket
      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()}")

      # Get OAuth token
      token = get_oauth_token(KYRIBA_HOST, CLIENT_ID, CLIENT_SECRET)
      print("Successfully obtained OAuth2 token")

      # Fetch logs
      records, newest_event_time = fetch_logs(
        host=KYRIBA_HOST,
        token=token,
        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(host: str, token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int):
    """
    Fetch audit trail logs from Kyriba API with pagination and rate limiting.

    Args:
      host: Kyriba instance URL
      token: OAuth2 access token
      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 = host.rstrip('/')
    endpoint = f"{base_url}/gateway/api/v1/audit-trails"

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

    records = []
    newest_time = None
    page_num = 0
    backoff = 1.0
    offset = 0

    start_date = start_time.strftime('%Y-%m-%d')
    end_date = end_time.strftime('%Y-%m-%d')

    while True:
      page_num += 1

      if len(records) >= max_records:
        print(f"Reached max_records limit ({max_records})")
        break

      params = []
      params.append(f"startDate={start_date}")
      params.append(f"endDate={end_date}")
      params.append(f"offset={offset}")
      params.append(f"limit={min(page_size, max_records - len(records))}")
      url = f"{endpoint}?{'&'.join(params)}"

      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'))

        page_results = data.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:
            event_time = event.get('dateTime') or event.get('date')
            if event_time:
              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) < page_size:
          print(f"Reached last page (size={len(page_results)} < limit={page_size})")
          break

        offset += 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

  3. 点击部署以保存并部署函数。

  4. 等待部署完成（2-3 分钟）。

创建 Cloud Scheduler 作业

Cloud Scheduler 将定期向 Pub/Sub 主题发布消息，从而触发 Cloud Run 函数。

  1. 在 GCP 控制台中，前往 Cloud Scheduler。
  2. 点击创建作业。

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

    设置 值
    名称 kyriba-logs-collector-hourly
    区域 选择与 Cloud Run 函数相同的区域
    频率 0 * * * *（每小时整点）
    时区 选择时区（建议选择世界协调时间 [UTC]）
    目标类型 Pub/Sub
    主题 选择 Pub/Sub 主题 (kyriba-logs-trigger)
    消息正文 {}（空 JSON 对象）

  4. 点击创建。

时间表频率选项

根据日志量和延迟时间要求选择频次：

频率 Cron 表达式 使用场景
每隔 5 分钟 */5 * * * * 大容量、低延迟
每隔 15 分钟 */15 * * * * 搜索量中等
每小时 0 * * * * 标准（推荐）
每 6 小时 0 */6 * * * 低量批处理
每天 0 0 * * * 历史数据收集

测试集成

  1. 在 Cloud Scheduler 控制台中，找到您的作业。
  2. 点击强制运行以手动触发作业。
  3. 等待几秒钟。
  4. 前往 Cloud Run > 服务。
  5. 点击函数名称 (kyriba-logs-collector)。
  6. 点击日志标签页。

  7. 验证函数是否已成功执行。查找：

    Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
Successfully obtained OAuth2 token
Page 1: Retrieved X events
Wrote X records to gs://kyriba-treasury-logs/kyriba/logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

  8. 前往 Cloud Storage > 存储桶。

  9. 点击您的存储桶名称 (kyriba-treasury-logs)。

  10. 前往前缀文件夹 (kyriba/)。

  11. 验证是否已创建具有当前时间戳的新 .ndjson 文件。

如果您在日志中看到错误，请执行以下操作：

  • HTTP 401：检查环境变量中的 OAuth2 凭据（客户端 ID 和客户端密钥）
  • HTTP 403：验证 API 应用是否具有“审核轨迹”范围的访问权限
  • HTTP 429：速率限制 - 函数将自动重试并进行退避
  • 缺少环境变量：检查是否已设置所有必需的变量

检索 Google SecOps 服务账号

Google SecOps 使用唯一的服务账号从您的 GCS 存储桶中读取数据。您必须向此服务账号授予对您的存储桶的访问权限。

获取服务账号电子邮件地址

  1. 前往 SIEM 设置 > Feed。
  2. 点击添加新 Feed。
  3. 点击配置单个 Feed。
  4. 在 Feed 名称字段中，输入 Feed 的名称（例如 Kyriba Treasury Management Logs）。
  5. 选择 Google Cloud Storage V2 作为来源类型。
  6. 选择 Kyriba Treasury Management 作为日志类型。
  7. 点击获取服务账号。

  8. 系统会显示一个唯一的服务账号电子邮件地址，例如：

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

  9. 复制此电子邮件地址，以便在下一步中使用。

  10. 点击下一步。

  11. 为以下输入参数指定值：

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

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

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

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

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

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

    • 资源命名空间：资源命名空间

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

  12. 点击下一步。

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

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

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

  1. 前往 Cloud Storage > 存储桶。
  2. 点击您的存储桶名称（例如 kyriba-treasury-logs）。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：粘贴 Google SecOps 服务账号电子邮件地址
    • 分配角色：选择 Storage Object Viewer

  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
column11 metadata.description 直接复制值
column16、column17 metadata.event_timestamp 使用日期过滤器从日期和时间字段解析，格式为“MM/dd/yyyy hh:mm A”和“MM/dd/yyyy h:m A”
principal_userid metadata.event_type 如果 principal_userid 不为空，则设置为“USER_RESOURCE_CREATION”，否则设置为“GENERIC_EVENT”
第 3 列 principal.user.company_name 直接复制值
column15 principal.user.userid 直接复制值
状态 sec_result.action 如果状态为“已汇款”，则设置为“ALLOW”，否则设置为“BLOCK”
column6 sec_result.description 直接复制值
sec_result security_result 直接复制值
column4 target.location.name 直接复制值
第 1 列 target.resource.id 直接复制值
target.resource.name 设置为“TRANSACTION”
target.resource.resource_type
column13 target.user.company_name 直接复制值
metadata.product_name 设置为“KYRIBA TREASURY”
metadata.vendor_name 设置为“KYRIBA”

需要更多帮助？获得社区成员和 Google SecOps 专业人士的解答。