收集 Entrust Identity Verification（以前称为 Onfido）日志

支持的平台：

Google SecOps SIEM

本文档介绍了如何使用 Google Cloud Storage V2 将 Entrust Identity Verification（以前称为 Onfido）日志注入到 Google Security Operations。解析器会将原始 Onfido 验证检查和报告日志转换为 Google SecOps UDM 架构。

Entrust Identity Verification 是一个基于云的身份验证平台，可自动执行证件验证、生物识别分析和欺诈检测。它提供了一个 REST API，用于管理申请人、验证检查和报告，使组织能够将身份验证工作流集成到其应用中。

准备工作

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

• Google SecOps 实例
• 已启用 Cloud Storage API 的 GCP 项目
• 创建和管理 GCS 存储分区的权限
• 管理 GCS 存储分区的 IAM 政策的权限
• 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
• 具有 API 访问权限的 Entrust Identity Verification（以前称为 Onfido）账号
• 具有足够权限来读取检查和报告的 Onfido API 令牌

收集 Onfido API 凭据

获取 API 令牌

1. 登录 Onfido 信息中心。
2. 依次前往开发者 > API 令牌。
3. 复制现有的有效 API 令牌，或点击 Generate API token（生成 API 令牌）以创建新令牌。
4. 输入令牌的名称（例如，Google Security Operations Integration）。
5. 选择直播作为令牌类型。

6. 复制并妥善保存 API 令牌。

   注意： API 令牌只会显示一次。创建后立即将其存储在安全的位置。

验证权限

如需验证 API 令牌是否具有必需的权限，请执行以下操作：

1. 登录 Onfido 信息中心。
2. 依次前往开发者 > API 令牌。
3. 确认相应令牌的状态为有效且未被撤消。
4. 通过测试 API 访问权限，验证令牌是否具有对检查和报告的读取权限。

测试 API 访问权限

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

  # Replace with your actual API token
  ONFIDO_API_TOKEN="your-api-token"
  
  # Test API access - list checks
  curl -v -H "Authorization: Token token=${ONFIDO_API_TOKEN}" \
    "[https://api.onfido.com/v3.6/checks](https://api.onfido.com/v3.6/checks)"
  

如果响应成功，则会返回 HTTP 200，并附带一个包含 checks 数组的 JSON 对象。

创建 Google Cloud Storage 存储桶

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

4. 点击创建存储分区。

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

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

6. 点击创建。

为 Cloud Run 函数创建服务账号

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

创建服务账号

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

创建 Cloud Run 函数以收集日志

Cloud Run 函数将由来自 Cloud Scheduler 的 Pub/Sub 消息触发，以从 Onfido API 中提取验证检查和报告，并将其写入 GCS。

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

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

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

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

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

6. 在身份验证部分中：

   1. 选择需要进行身份验证。
   2. 检查 Identity and Access Management (IAM)。
   注意： 调用函数时，Pub/Sub 会自动处理身份验证。

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

8. 前往安全性标签页：

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

9. 前往容器标签页：

   1. 点击变量和密钥。
   2. 为每个环境变量点击+ 添加变量：

   变量名称	示例值	说明
   GCS_BUCKET	onfido-verification-logs	GCS 存储桶名称
   GCS_PREFIX	onfido-logs	日志文件的前缀
   STATE_KEY	onfido-logs/state.json	状态文件路径
   ONFIDO_API_TOKEN	your-api-token-here	Onfido API 令牌
   MAX_RECORDS	1000	每次运行的记录数上限
   PAGE_SIZE	100	每页记录数
   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', 'onfido-logs')
   STATE_KEY = os.environ.get('STATE_KEY', 'onfido-logs/state.json')
   ONFIDO_API_TOKEN = os.environ.get('ONFIDO_API_TOKEN')
   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'))
   
   API_BASE = '[https://api.onfido.com/v3.6](https://api.onfido.com/v3.6)'
   
   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 Onfido verification
       checks and reports and write to GCS.
   
       Args:
           cloud_event: CloudEvent object containing Pub/Sub message
       """
   
       if not all([GCS_BUCKET, ONFIDO_API_TOKEN]):
           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()}")
   
           # Fetch checks
           checks, newest_check_time = fetch_checks(
               api_token=ONFIDO_API_TOKEN,
               start_time=last_time,
               end_time=now,
               page_size=PAGE_SIZE,
               max_records=MAX_RECORDS,
           )
   
           # Fetch reports for each check
           all_records = []
           for check in checks:
               check_record = check.copy()
               check_id = check.get('id')
               if check_id:
                   reports = fetch_reports(api_token=ONFIDO_API_TOKEN, check_id=check_id)
                   check_record['reports'] = reports
               all_records.append(check_record)
   
           if not all_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 all_records]) + '\n'
           blob.upload_from_string(ndjson, content_type='application/x-ndjson')
   
           print(f"Wrote {len(all_records)} records to gs://{GCS_BUCKET}/{object_key}")
   
           # Update state with newest event time
           if newest_check_time:
               save_state(bucket, STATE_KEY, newest_check_time)
           else:
               save_state(bucket, STATE_KEY, now.isoformat())
   
           print(f"Successfully processed {len(all_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_checks(api_token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int):
       """
       Fetch verification checks from the Onfido API with pagination and rate limiting.
   
       Args:
           api_token: Onfido API token
           start_time: Start time for check query
           end_time: End time for check query
           page_size: Number of records per page
           max_records: Maximum total records to fetch
   
       Returns:
           Tuple of (checks list, newest_event_time ISO string)
       """
       headers = {
           'Authorization': f'Token token={api_token}',
           'Accept': 'application/json',
           'User-Agent': 'GoogleSecOps-OnfidoCollector/1.0'
       }
   
       records = []
       newest_time = None
       page_num = 0
       backoff = 1.0
       current_page = 1
   
       while True:
           page_num += 1
   
           if len(records) >= max_records:
               print(f"Reached max_records limit ({max_records})")
               break
   
           url = f"{API_BASE}/checks?page={current_page}&per_page={page_size}"
   
           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('checks', [])
   
               if not page_results:
                   print(f"No more results (empty page)")
                   break
   
               # Filter checks within the time window
               filtered = []
               for check in page_results:
                   created_at = check.get('created_at')
                   if created_at:
                       try:
                           check_time = parse_datetime(created_at)
                           if start_time <= check_time <= end_time:
                               filtered.append(check)
                           if newest_time is None or check_time > parse_datetime(newest_time):
                               newest_time = created_at
                       except Exception as e:
                           print(f"Warning: Could not parse check time: {e}")
                           filtered.append(check)
   
               print(f"Page {page_num}: Retrieved {len(page_results)} checks, {len(filtered)} in time window")
               records.extend(filtered)
   
               # Check for more results
               if len(page_results) < page_size:
                   print(f"Reached last page (size={len(page_results)} < limit={page_size})")
                   break
   
               current_page += 1
   
           except Exception as e:
               print(f"Error fetching checks: {e}")
               return [], None
   
       print(f"Retrieved {len(records)} total checks from {page_num} pages")
       return records[:max_records], newest_time
   
   def fetch_reports(api_token: str, check_id: str):
       """
       Fetch reports for a specific check from the Onfido API.
   
       Args:
           api_token: Onfido API token
           check_id: Check ID to fetch reports for
   
       Returns:
           List of report objects
       """
       headers = {
           'Authorization': f'Token token={api_token}',
           'Accept': 'application/json',
           'User-Agent': 'GoogleSecOps-OnfidoCollector/1.0'
       }
   
       url = f"{API_BASE}/reports?check_id={check_id}"
   
       try:
           response = http.request('GET', url, headers=headers)
   
           if response.status == 429:
               time.sleep(2)
               response = http.request('GET', url, headers=headers)
   
           if response.status != 200:
               print(f"Error fetching reports for check {check_id}: HTTP {response.status}")
               return []
   
           data = json.loads(response.data.decode('utf-8'))
           reports = data.get('reports', [])
           return reports
   
       except Exception as e:
           print(f"Error fetching reports for check {check_id}: {e}")
           return []
   

   • 第二个文件：requirements.txt:：

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

   注意： 此脚本仅作为示例提供，不受官方支持。欢迎您提供反馈，帮助我们改进此脚本。如需提交反馈，请点击此页面上的发送反馈 > Google SecOps 安全产品反馈。

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

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

   注意： Pub/Sub 触发器配置会自动创建必要的订阅和权限。

创建 Cloud Scheduler 作业

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

1. 在 GCP Console 中，前往 Cloud Scheduler。

2. 点击创建作业。

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

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

4. 点击创建。

时间表频率选项

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

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

测试集成

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

7. 验证函数是否已成功执行。请查找以下内容：

   Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
   Page 1: Retrieved X checks, X in time window
   Wrote X records to gs://bucket-name/onfido-logs/logs_YYYYMMDD_HHMMSS.ndjson
   Successfully processed X records
   

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

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

10. 转到 onfido-logs/ 文件夹。

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

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

• HTTP 401：检查环境变量中的 Onfido API 令牌
• HTTP 403：验证 API 令牌是否具有有效访问权限且未被撤消
• HTTP 429：速率限制 - 函数将自动重试并进行退避
• 缺少环境变量：检查是否已设置所有必需的变量

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

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

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

   [e-mail]
   

8. 复制此电子邮件地址。您将在下一步骤中用到它。

   注意： 每个 Google SecOps 实例都有一个唯一的服务账号。请勿使用其他文档或示例中的服务账号。

9. 点击下一步。

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

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

      gs://onfido-verification-logs/onfido-logs/
      

      • 替换：
        • onfido-verification-logs：您的 GCS 存储桶名称。
        • onfido-logs：存储日志的可选前缀/文件夹路径（留空表示根目录）。
    注意： 请务必在 URI 末尾添加尾随斜杠 (/)。

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

      • 永不：转移后永不删除任何文件（建议用于测试）。
      • 删除已转移的文件：在成功转移后删除文件。
      • 删除已转移的文件和空目录：成功转移后删除文件和空目录。
      注意： 如果您选择删除选项，服务账号必须具有 Storage Object Admin 角色，而不是 Storage Object Viewer 角色。相应地更新 IAM 权限。

    • 文件存在时间上限：包含在过去指定天数内修改的文件。默认值为 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 映射	逻辑
	read_only_udm.metadata.vendor_name	设置为“ONFIDO”。
	read_only_udm.metadata.product_name	设置为“ONFIDO”。
	read_only_udm.metadata.log_type	设置为“ONFIDO”。

更新日志

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

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