收集 ForgeRock OpenIDM 日志

支持的平台：

Google SecOps SIEM

注意： 此功能受《Google Security Operations 服务专用条款》的正式发布前产品条款的约束。我们对正式发布前功能的支持可能有限，并且对正式发布前功能的更改与其他正式发布前版本可能不兼容。如需了解详情，请参阅 Google SecOps 技术支持服务准则和 Google SecOps 服务专用条款。

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

ForgeRock OpenIDM（现已更名为 PingIDM）是一种身份管理平台，可提供用户配置、同步、密码管理和访问权限治理功能。它会将身份生命周期事件、身份验证尝试、协调操作和配置更改记录到可通过 REST 访问的审核日志中。

准备工作

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

• Google SecOps 实例
• 已启用 Cloud Storage API 的 GCP 项目
• 创建和管理 GCS 存储分区的权限
• 管理 GCS 存储分区的 IAM 政策的权限
• 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
• 使用管理凭据对 ForgeRock OpenIDM 或 PingIDM 实例进行特权访问

创建 Google Cloud Storage 存储分区

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

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

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

6. 点击创建。

收集 ForgeRock OpenIDM 凭据

获取 ForgeRock OpenIDM 基础网址

1. 登录您的 ForgeRock OpenIDM 或 PingIDM 实例。
2. 记下浏览器地址栏中的基本网址。
   • 格式：https://openidm.example.com
   • 请勿添加尾部斜杠或 /admin 等路径

获取管理凭据

1. 获取 ForgeRock OpenIDM 实例的管理凭据。

2. 您需要有：

   • 用户名：管理员用户名（例如 openidm-admin）
   • 密码：管理密码
   注意： 用户账号必须拥有通过 REST API 查询审核日志的权限。默认 openidm-admin 用户拥有这些权限。

验证权限

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

1. 登录 ForgeRock OpenIDM。
2. 依次前往配置 > 系统偏好设置 > 审核。
3. 如果您能看到审核配置和主题，则表示您拥有所需的权限。
4. 如果您看不到此选项，请与您的管理员联系，以获取审核读取权限。

测试 API 访问权限

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

# Replace with your actual credentials
OPENIDM_BASE_URL="https://openidm.example.com"
OPENIDM_USERNAME="openidm-admin"
OPENIDM_PASSWORD="your-admin-password"

# Test API access to authentication audit topic
curl -v \
    -H "X-OpenIDM-Username: ${OPENIDM_USERNAME}" \
    -H "X-OpenIDM-Password: ${OPENIDM_PASSWORD}" \
    -H "Accept-API-Version: resource=1.0" \
    -H "Accept: application/json" \
    "${OPENIDM_BASE_URL}/openidm/audit/authentication?_queryFilter=true&_pageSize=1"

预期响应：HTTP 200，包含审核事件的 JSON。

注意： /openidm/audit REST 查询端点已在 PingIDM 8.x 中弃用，并可能会在未来的版本中移除。请参阅 PingIDM 版本说明，了解其他导出方法。

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个服务账号，该账号具有向 GCS 存储分区写入内容以及被 Pub/Sub 调用的权限。

创建服务账号

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

创建发布/订阅主题

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

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

创建 Cloud Run 函数以收集日志

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

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

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

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

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

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

6. 在身份验证部分中：

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

7. 滚动到容器、网络、安全性并展开该部分。

8. 前往安全标签页：

   • 服务账号：选择服务账号 forgerock-openidm-collector-sa。

9. 前往容器标签页：

   1. 点击变量和密钥。

   2. 为每个环境变量点击 + 添加变量：

      变量名称	示例值	说明
      GCS_BUCKET	forgerock-openidm-audit-logs	GCS 存储分区名称
      GCS_PREFIX	openidm	日志文件的前缀
      STATE_KEY	openidm/state.json	状态文件路径
      OPENIDM_BASE_URL	https://openidm.example.com	OpenIDM 基础网址
      OPENIDM_USERNAME	openidm-admin	OpenIDM 管理员用户名
      OPENIDM_PASSWORD	your-admin-password	OpenIDM 管理员密码
      AUDIT_TOPICS	access,activity,authentication,config,sync	以英文逗号分隔的审核主题
      PAGE_SIZE	100	每页记录数
      MAX_PAGES	50	每个主题的页面数量上限

   注意： 可用的审核主题包括：access、activity、authentication、config、recon 和 sync。必须先在 conf/audit.json 中启用 recon 主题，然后才能进行收集。

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

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

11. 前往设置标签页：

    • 在资源部分中：
      • 内存：选择 512 MiB 或更高值。
      • CPU：选择 1。
    • 在修订版本伸缩部分中：
      • 实例数下限：输入 0。
      • 实例数上限：输入 100（或根据预期负载进行调整）。

12. 点击创建。

13. 等待服务创建完成（1-2 分钟）。

14. 创建服务后，系统会自动打开内嵌代码编辑器。

添加函数代码

1. 在入口点字段中输入 main。

2. 在内嵌代码编辑器中，创建两个文件：

   • 第一个文件：main.py:：

   import functions_framework
   from google.cloud import storage
   import json
   import os
   import urllib3
   from datetime import datetime, timezone
   
   # 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', 'openidm')
   STATE_KEY = os.environ.get('STATE_KEY', 'openidm/state.json')
   OPENIDM_BASE_URL = os.environ.get('OPENIDM_BASE_URL')
   OPENIDM_USERNAME = os.environ.get('OPENIDM_USERNAME')
   OPENIDM_PASSWORD = os.environ.get('OPENIDM_PASSWORD')
   AUDIT_TOPICS = os.environ.get('AUDIT_TOPICS', 'access,activity,authentication,config,sync').split(',')
   PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100'))
   MAX_PAGES = int(os.environ.get('MAX_PAGES', '50'))
   
   @functions_framework.cloud_event
   def main(cloud_event):
       """
       Cloud Run function triggered by Pub/Sub to fetch ForgeRock OpenIDM logs and write to GCS.
   
       Args:
           cloud_event: CloudEvent object containing Pub/Sub message
       """
   
       if not all([GCS_BUCKET, OPENIDM_BASE_URL, OPENIDM_USERNAME, OPENIDM_PASSWORD]):
           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)
   
           all_events = []
           for topic in AUDIT_TOPICS:
               topic = topic.strip()
               print(f"Fetching audit logs for topic: {topic}")
               events = fetch_audit_logs(topic, state.get(topic, {}))
               all_events.extend(events)
   
               if events:
                   latest_timestamp = max(e.get('timestamp', '') for e in events)
                   state[topic] = {
                       'last_timestamp': latest_timestamp,
                       'last_run': datetime.now(timezone.utc).isoformat(),
                       'events_count': len(events)
                   }
   
           if all_events:
               write_to_gcs(bucket, all_events)
               save_state(bucket, STATE_KEY, state)
               print(f"Successfully processed {len(all_events)} audit events")
           else:
               print("No new audit events to process")
   
       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, state):
       """Save state to GCS."""
       try:
           blob = bucket.blob(key)
           blob.upload_from_string(
               json.dumps(state, indent=2),
               content_type='application/json'
           )
           print(f"Saved state: {json.dumps(state)}")
       except Exception as e:
           print(f"Warning: Could not save state: {e}")
   
   def fetch_audit_logs(topic, topic_state):
       """
       Fetch audit logs from ForgeRock OpenIDM API with pagination.
   
       Args:
           topic: Audit topic name
           topic_state: State dictionary for this topic
   
       Returns:
           List of audit events
       """
       base_url = OPENIDM_BASE_URL.rstrip('/')
   
       all_events = []
       last_timestamp = topic_state.get('last_timestamp')
   
       query_filter = 'true'
       if last_timestamp:
           query_filter = f'timestamp gt "{last_timestamp}"'
   
       page_offset = 0
       page_count = 0
   
       while page_count < MAX_PAGES:
           try:
               url = f"{base_url}/openidm/audit/{topic}"
               params = {
                   '_queryFilter': query_filter,
                   '_pageSize': str(PAGE_SIZE),
                   '_pagedResultsOffset': str(page_offset),
                   '_sortKeys': 'timestamp'
               }
   
               query_string = '&'.join([f"{k}={urllib3.request.urlencode({k: v})[len(k)+1:]}" for k, v in params.items()])
               full_url = f"{url}?{query_string}"
   
               headers = {
                   'X-OpenIDM-Username': OPENIDM_USERNAME,
                   'X-OpenIDM-Password': OPENIDM_PASSWORD,
                   'Accept-API-Version': 'resource=1.0',
                   'Accept': 'application/json'
               }
   
               response = http.request('GET', full_url, headers=headers)
   
               if response.status != 200:
                   print(f"API error for topic {topic}: {response.status} - {response.data.decode('utf-8')}")
                   break
   
               data = json.loads(response.data.decode('utf-8'))
               events = data.get('result', [])
   
               if not events:
                   print(f"No more events for topic {topic}")
                   break
   
               all_events.extend(events)
               page_offset += PAGE_SIZE
               page_count += 1
   
               print(f"Fetched page {page_count} for topic {topic}, total events: {len(all_events)}")
   
               if len(events) < PAGE_SIZE:
                   break
   
           except urllib3.exceptions.HTTPError as e:
               print(f"HTTP error for topic {topic}: {str(e)}")
               break
           except json.JSONDecodeError as e:
               print(f"JSON decode error for topic {topic}: {str(e)}")
               break
           except Exception as e:
               print(f"Unexpected error for topic {topic}: {str(e)}")
               break
   
       return all_events
   
   def write_to_gcs(bucket, events):
       """Write events to GCS as NDJSON."""
       timestamp = datetime.now(timezone.utc).strftime('%Y%m%d_%H%M%S')
       filename = f"{GCS_PREFIX}/openidm_audit_{timestamp}.json"
   
       ndjson_content = '\n'.join([json.dumps(event) for event in events])
   
       blob = bucket.blob(filename)
       blob.upload_from_string(
           ndjson_content.encode('utf-8'),
           content_type='application/x-ndjson'
       )
   
       print(f"Wrote {len(events)} events to gs://{GCS_BUCKET}/{filename}")
   

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

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

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

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

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

创建 Cloud Scheduler 作业

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

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

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

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

4. 点击创建。

时间表频率选项

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

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

测试集成

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

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

   Fetching audit logs for topic: access
   Fetched page 1 for topic access, total events: X
   Wrote X events to gs://forgerock-openidm-audit-logs/openidm/openidm_audit_YYYYMMDD_HHMMSS.json
   Successfully processed X audit events
   

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

9. 点击您的存储桶名称 forgerock-openidm-audit-logs。

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

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

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

• HTTP 401：检查环境变量中的 OpenIDM 凭据
• HTTP 403：验证账号是否具有审核读取权限
• HTTP 404：验证 OPENIDM_BASE_网址 是否正确，且不包含尾随路径
• 缺少环境变量：检查是否已设置所有必需的变量

检索 Google SecOps 服务账号

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

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

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

6. 选择 FORGEROCK_OPENIDM 作为日志类型。

7. 点击获取服务账号。

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

   [e-mail]
   

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

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

10. 点击下一步。

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

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

    gs://forgerock-openidm-audit-logs/openidm/
    

    • 替换：
      • forgerock-openidm-audit-logs：您的 GCS 存储分区名称。
      • openidm：存储日志的前缀路径。
    注意： 请务必在 URI 末尾添加尾随斜杠 (/)。
    • 源删除选项：根据您的偏好选择删除选项：
      • 永不：永不删除转移后的任何文件（建议用于测试）。
      • 删除已转移的文件：在成功转移后删除文件。
      • 删除已转移的文件和空目录：在成功转移后删除文件和空目录。
    注意： 如果您选择删除选项，服务账号必须具有 Storage Object Admin 角色，而不是 Storage Object Viewer 角色。相应地更新 IAM 权限。
    • 文件存在时间上限：包含在过去指定天数内修改的文件。默认值为 180 天。
    • 资产命名空间：资产命名空间。
    • 注入标签：要应用于此 Feed 中事件的标签。

12. 点击下一步。

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

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

Google SecOps 服务账号需要对您的 GCS 存储分区具有 Storage Object Viewer 角色。

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

6. 点击保存。

   注意： 如果您打算使用“删除已转移的文件”或“删除已转移的文件和空目录”删除选项，请授予存储对象管理员角色，而不是存储对象查看者角色。

UDM 映射表

日志字段	UDM 映射	逻辑
additional_label、additional_elapsed_time、additional_ContentLength、additional_accept_encoding、additional_Accept、additional_accept_language、additional_origin_hop、additional_cache_control、additional_Connection、additional_Cookie、additional_Pragma、additional_exchange_id、additional_contentType、additional_X-content_type-Options、fluenttag_label、source_label、topic_label、request_protocol_label、taskName_label、linkQualifier_label、situation_label、mapping_label、eventid_label、context_roles_label、field_names_label	additional.fields	其他键值对
Via	intermediary.hostname	中介的主机名
x_forwarded_ip、ip、caller.callerIps	intermediary.ip	中介的 IP 地址
时间戳	metadata.event_timestamp	事件的时间戳
	metadata.event_type	事件类型
transactionId	metadata.product_deployment_id	商品的部署标识符
eventName	metadata.product_event_type	来自产品的事件类型
_id、trackingIds	metadata.product_log_id	产品中的日志标识符
http.request.secure	network.application_protocol	应用协议
http_version	network.application_protocol_version	应用协议的版本
request_method, http.request.method	network.http.method	HTTP 方法
user_agent, http.request.headers.user_agent.0	network.http.parsed_user_agent	已解析的用户代理
refferal_url	network.http.referral_url	引荐网址
response.statusCode, status_code	network.http.response_code	HTTP 响应代码
user_agent, http.request.headers.user_agent	network.http.user_agent	用户代理字符串
transaction_id、transactionId	network.session_id	会话标识符
主机	principal.asset.hostname	委托人资产的主机名
true_client_ip、client.ip、context.ipAddress、entry.info.ipAddress、src_ip	principal.asset.ip	主账号的资产的 IP 地址
主机	principal.hostname	主账号的主机名
true_client_ip、client.ip、context.ipAddress、entry.info.ipAddress、src_ip	principal.ip	主账号的 IP 地址
client.port、src_port	principal.port	委托人的端口
component_label、moduleId_label、query_id_label	principal.resource.attribute.labels	主账号资源的属性标签
entry.info.treeName	principal.resource.name	主账号资源的名称
sourceObjectId、objectId、entry.info.nodeId	principal.resource.product_object_id	主账号资源的商品对象 ID
entry.info.authLevel	principal.resource.resource_subtype	主账号资源的子类型
user_roles_property_label、authentication_id_label、authentication_id_property_label	principal.user.attribute.labels	主账号用户的属性标签
userId、principalData.0	principal.user.userid	主账号的用户 ID
security_action	security_result.action	安全性结果中采取的操作
结果、操作	security_result.action_details	操作的详细信息
result_label、moduleId_label、nodeType_label、displayName_label、nodeOutcome_label、elapsedTimeUnits_label、elapsedTime_label、operation_label、taskName_label、linkQualifier_label、situation_label、mapping_label	security_result.detection_fields	检测字段
level	security_result.severity	安全结果的严重程度
level	security_result.severity_details	严重程度详情
response_detail_reason	security_result.summary	安全结果摘要
http.request.headers.host.0	target.asset.hostname	目标资产的主机名
server.ip、x_forwarded_ip	target.asset.ip	目标资产的 IP 地址
http.request.headers.host.0	target.hostname	目标的主机名
server.ip、x_forwarded_ip	target.ip	目标的 IP 地址
server.port	target.port	目标端口
targetObjectId	target.resource.product_object_id	目标资源对应的商品对象 ID
http.request.path	target.url	目标的网址
	metadata.product_name	商品名称
	metadata.vendor_name	供应商名称

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