收集 Agiloft 日志

解析器版本：1.0

支持的平台：

本文档介绍了如何使用 Google Cloud Storage V2 将 Agiloft 日志注入到 Google Security Operations。

Agiloft 是一个免代码合同生命周期管理 (CLM) 平台，可自动执行合同创建、审批工作流和合规性跟踪。Agiloft 活动日志表记录系统使用情况事件，例如用户登录、退出、记录修改、规则更改和管理操作。这些活动日志可以通过 Agiloft REST API 导出，并写入 GCS 存储桶以供 Google SecOps 提取。

准备工作

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

  • Google SecOps 实例
  • 已启用 Cloud Storage API 的 GCP 项目
  • 创建和管理 GCS 存储分区的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 具有高级版、Premium 版或 Platform 版的 Agiloft 实例（需要使用其中一个版本才能访问 REST API）
  • REST 已启用的群组中具有“活动日志”表访问权限的 Agiloft 用户账号
  • 在 Agiloft 知识库 (KB) 中启用活动日志记录

配置 Agiloft 活动日志记录

  1. 使用管理员账号登录 Agiloft 知识库。
  2. 点击右上角的设置齿轮图标。
  3. 依次前往系统 > 配置活动日志。
  4. 点击新建以打开审核规则向导。
  5. 提供以下配置详细信息：
    • 名称：输入规则的名称（例如 All Activity for SIEM）
    • 语言：选择知识库语言
  6. 创建或选择一个已保存的搜索查询，以确定要记录哪些用户的操作。
  7. 选择要跟踪的活动。如需进行全面的安全监控，请选择：
    • 登录
    • 退出
    • 登录失败
    • 记录创建
    • 记录编辑
    • 记录删除
    • 文件下载
    • 规则修改
    • 工作流修改
    • 批量修改
    • 团队编辑
    • 表格修改
    • 列修改
  8. 定义审核记录的保留期限（例如 1 year）。

  9. 点击完成。

取消隐藏“活动日志”表格

  1. 在 Agiloft 知识库中，依次前往设置 > 表。
  2. 从表格列表中选择活动日志。

  3. 点击取消隐藏，使 API 查询可以访问活动日志表。

收集 Agiloft API 凭据

获取 Agiloft 实例详细信息

  1. 登录您的 Agiloft 实例。

  2. 请注意浏览器地址栏中的以下值：

    • 主机名：服务器地址（例如 yourcompany.agiloft.com）
    • 知识库名称：知识库名称，显示在知识库右上角“帮助”图标旁边（例如 Production）

创建专用 API 用户

  1. 在 Agiloft 知识库中，依次前往设置 > 访问权限 > 用户。
  2. 创建一个专门用于 API 访问的新用户账号：
    • 登录：输入描述性登录信息（例如 siem_api_user）
    • 密码：设置安全系数高的密码

  3. 将用户添加到已启用 REST API 访问权限且对活动日志表具有读取权限的群组。

验证权限

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

  1. 使用 API 用户凭据登录 Agiloft。
  2. 依次前往设置 > 表格。
  3. 验证活动日志表是否可见且可访问。
  4. 如果您看不到“活动日志”表格，请与 Agiloft 管理员联系，让其授予必要的群组权限。

测试 API 访问权限

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

    AGILOFT_HOST="https://yourcompany.agiloft.com"
AGILOFT_KB="YourKBName"
AGILOFT_LOGIN="siem_api_user"
AGILOFT_PASSWORD="your-password"

# Test login and get JWT token
TOKEN=$(curl -s "${AGILOFT_HOST}/ewws/EWLogin?$KB=${AGILOFT_KB}&\$login=${AGILOFT_LOGIN}&\$password=${AGILOFT_PASSWORD}&\$lang=en" \
  | python3 -c "import sys,json; data=json.load(sys.stdin); print(data.get('token',''))")

echo "Token: ${TOKEN}"

# Test Activity Log table access with JSON format
curl -v "${AGILOFT_HOST}/ewws/EWSearch/.json?\$KB=${AGILOFT_KB}&\$table=activity_log&\$login=${AGILOFT_LOGIN}&\$password=${AGILOFT_PASSWORD}&\$lang=en&limit=1&page=0&field=id&field=action&field=description&field=login&field=date" \
  -H "Accept: application/json"

创建 Google Cloud Storage 存储桶

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

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

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

  6. 点击创建。

为 Cloud Run 函数创建服务账号

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

创建服务账号

  1. 在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
  2. 点击创建服务账号。
  3. 提供以下配置详细信息：
    • 服务账号名称：输入 agiloft-logs-collector-sa
    • 服务账号说明：输入 Service account for Cloud Run function to collect Agiloft activity 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. 点击您的存储桶名称。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：输入服务账号电子邮件地址（例如 agiloft-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：输入 agiloft-logs-trigger
    • 将其他设置保留为默认值
  4. 点击创建。

创建 Cloud Run 函数以收集日志

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

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

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

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

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

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

  6. 在身份验证部分中：

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

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

  8. 前往安全性标签页：

    • 服务账号：选择服务账号 agiloft-logs-collector-sa

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击+ 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET agiloft-activity-logs GCS 存储桶名称
    GCS_PREFIX agiloft 日志文件的前缀
    STATE_KEY agiloft/state.json 状态文件路径
    AGILOFT_HOST https://yourcompany.agiloft.com Agiloft 实例网址
    AGILOFT_KB YourKBName Agiloft 知识库名称（区分大小写）
    AGILOFT_LOGIN siem_api_user API 用户登录
    AGILOFT_PASSWORD your-password API 用户密码
    PAGE_SIZE 100 每个 API 页面的记录数
    MAX_RECORDS 10000 每次运行的记录数上限
    LOOKBACK_HOURS 2 初始回溯期

  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
import urllib.parse
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', 'agiloft').strip('/')
STATE_KEY = os.environ.get('STATE_KEY') or f"{GCS_PREFIX}/state.json"
AGILOFT_HOST = os.environ.get('AGILOFT_HOST', '').rstrip('/')
AGILOFT_KB = os.environ.get('AGILOFT_KB')
AGILOFT_LOGIN = os.environ.get('AGILOFT_LOGIN')
AGILOFT_PASSWORD = os.environ.get('AGILOFT_PASSWORD')
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100'))
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000'))
LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '2'))

ACTIVITY_LOG_FIELDS = [
  'id', 'action', 'action_duration', 'login', 'user_name',
  'user_primary_team', 'company', 'cookie', 'date',
  'description', 'groups', 'interface', 'ip',
  'record_id', 'rule_id', 'session_duration',
  'session_id', 'table_label'
]

def parse_datetime(value):
  """Parse ISO datetime string to datetime object."""
  if not value:
    return None
  if value.endswith("Z"):
    value = value[:-1] + "+00:00"
  try:
    return datetime.fromisoformat(value)
  except Exception:
    return None

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch
  Agiloft Activity Log records and write to GCS.

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

  if not all([GCS_BUCKET, AGILOFT_HOST, AGILOFT_KB, AGILOFT_LOGIN, AGILOFT_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 delayed events
        if last_time:
          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 activity logs from {last_time.isoformat()} to {now.isoformat()}")

    # Fetch activity logs
    records, newest_event_time = fetch_activity_logs(
      start_time=last_time,
      end_time=now,
    )

    if not records:
      print("No new activity 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
    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 activity 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):
  """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_activity_logs(start_time, end_time):
  """
  Fetch activity logs from Agiloft REST API with pagination.

  Args:
    start_time: Start time for log query
    end_time: End time for log query

  Returns:
    Tuple of (records list, newest_event_time ISO string)
  """
  base_url = f"{AGILOFT_HOST}/ewws/EWSearch/.json"

  # Build field parameters
  field_params = '&'.join(
    [f"field={urllib.parse.quote(f)}" for f in ACTIVITY_LOG_FIELDS]
  )

  # Build date filter query
  start_str = start_time.strftime('%d %m %y %H:%M:%S')
  end_str = end_time.strftime('%d %m %y %H:%M:%S')
  query_filter = urllib.parse.quote(
    f"date >= '{start_str}' AND date <= '{end_str}'"
  )

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

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

    url = (
      f"{base_url}"
      f"?$KB={urllib.parse.quote(AGILOFT_KB)}"
      f"&$table=activity_log"
      f"&$login={urllib.parse.quote(AGILOFT_LOGIN)}"
      f"&$password={urllib.parse.quote(AGILOFT_PASSWORD)}"
      f"&$lang=en"
      f"&query={query_filter}"
      f"&limit={PAGE_SIZE}"
      f"&page={page_num}"
      f"&{field_params}"
    )

    try:
      response = http.request('GET', url)

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

      if not data.get('success', False):
        print(f"API error: {data.get('message', 'Unknown error')}")
        return [], None

      result = data.get('result', [])

      # Handle single record vs list
      if isinstance(result, dict):
        result = [result]

      if not result:
        print(f"No more results (empty page {page_num})")
        break

      print(f"Page {page_num}: Retrieved {len(result)} events")
      records.extend(result)

      # Track newest event time
      for event in result:
        try:
          event_time = event.get('date')
          if event_time:
            if newest_time is None:
              newest_time = event_time
            else:
              current_dt = parse_datetime(event_time)
              newest_dt = parse_datetime(newest_time)
              if current_dt and newest_dt and current_dt > newest_dt:
                newest_time = event_time
        except Exception as e:
          print(f"Warning: Could not parse event time: {e}")

      # Check pagination
      if len(result) < PAGE_SIZE:
        print(
          f"Reached last page (size={len(result)} < limit={PAGE_SIZE})"
        )
        break

      page_num += 1

    except Exception as e:
      print(f"Error fetching activity logs: {e}")
      return [], None

  print(f"Retrieved {len(records)} total records from {page_num + 1} 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 Console 中，前往 Cloud Scheduler。
  2. 点击创建作业。

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

    设置 值
    名称 agiloft-logs-collector-hourly
    区域 选择与 Cloud Run 函数相同的区域
    频率 0 * * * *（每小时一次，整点时）
    时区 选择时区（建议选择 UTC）
    目标类型 Pub/Sub
    主题 选择主题 agiloft-logs-trigger
    消息正文 {}（空 JSON 对象）

  4. 点击创建。

时间表频率选项

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

频率 Cron 表达式 使用场景
每小时 0 * * * * 标准（推荐）
每 2 小时 0 */2 * * * 调低音量
每 6 小时 0 */6 * * * 低成交量、批处理

测试集成

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

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

    Fetching activity logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
Page 0: Retrieved X events
Wrote X records to gs://agiloft-activity-logs/agiloft/logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

  8. 前往 Cloud Storage > 存储分区。

  9. 点击您的存储桶名称。

  10. 前往前缀文件夹 agiloft/。

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

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

  • HTTP 401：检查环境变量中的 API 凭据。验证登录名和密码是否正确。
  • HTTP 403：验证 API 用户是否对活动日志表具有读取权限，以及是否属于已启用 REST 的群组。
  • HTTP 429：速率限制 - 函数将自动重试并进行退避。
  • “success”: false：检查错误消息。常见原因包括知识库名称（区分大小写）或表名称不正确。
  • 缺少环境变量：检查是否已设置所有必需的变量。

在 Google SecOps 中配置 Feed 以注入 Agiloft 日志

  1. 依次前往 SIEM 设置 > Feed。
  2. 点击添加新 Feed。
  3. 点击配置单个 Feed。
  4. 在 Feed 名称字段中，输入 Feed 的名称（例如 Agiloft Activity Logs）。
  5. 选择 Google Cloud Storage V2 作为来源类型。
  6. 选择 Agiloft 作为日志类型。

  7. 点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址，例如：

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

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

  9. 点击下一步。

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

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

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

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

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

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

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

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

  11. 点击下一步。

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

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

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

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

  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
_1880_full_name_label additional.fields 已合并
_1888_full_name_label additional.fields 已合并
action_duration_label additional.fields 已合并
cookie_label additional.fields 已合并
creator_login_label additional.fields 已合并
creator_team_label additional.fields 已合并
deleteable_label additional.fields 已合并
demo_data_label additional.fields 已合并
interface_label additional.fields 已合并
login_label additional.fields 已合并
record_id_label additional.fields 已合并
table_label_label additional.fields 已合并
type_label additional.fields 已合并
description metadata.description 直接映射
date metadata.event_timestamp 解析为 MMM dd yyyy HH:mm:ss
date_created metadata.event_timestamp 解析为 MMM dd yyyy HH:mm:ss
date_updated metadata.event_timestamp 解析为 MMM dd yyyy HH:mm:ss
timestamp metadata.event_timestamp 解析为 dd/MMM/yyyy:HH:mm:ss Z
has_principal metadata.event_type 已映射：true → STATUS_UPDATE
has_principal_user metadata.event_type 已映射：true → USER_UNCATEGORIZED
activity_log_id metadata.product_deployment_id 直接映射
id metadata.product_log_id 直接映射
method network.http.method 直接映射
url network.http.referral_url 直接映射
response_code network.http.response_code 直接映射
byte_transferred network.received_bytes 直接映射
session_duration network.session_duration.seconds 直接映射
client_ip principal.asset.ip 已合并
ip principal.asset.ip 已合并
client_ip principal.ip 已合并
ip principal.ip 已合并
user_primary_team_label principal.user.attribute.labels 已合并
company principal.user.company_name 直接映射
groups principal.user.group_identifiers 已合并
user_name principal.user.user_display_name 直接映射
user principal.user.userid 直接映射
user_login principal.user.userid 直接映射
不适用 metadata.event_type 常量：USER_UNCATEGORIZED
不适用 metadata.product_name 常量：Agiloft
不适用 metadata.vendor_name 常量：Agiloft

更新日志

查看相应解析器的更改日志

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