收集 PingIDM（以前称为 ForgeRock OpenIDM）日志

解析器版本：4.0

支持的平台：

本文档介绍了如何使用 Google Cloud Storage V2 将 PingIDM（以前称为 ForgeRock OpenIDM）日志注入到 Google Security Operations。

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

准备工作

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

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

创建 Google Cloud Storage 存储桶

  1. 前往 Google Cloud 控制台。
  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）
    • 密码：管理密码

验证权限

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

测试 API 访问权限

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

    # Replace with your actual credentials
OPENIDM_BASE_URL="[https://openidm.example.com](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。

为 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. Storage Object Admin：用于将日志写入 GCS 存储桶并管理状态文件。
    2. Cloud Run Invoker：允许 Pub/Sub 调用该函数。
    3. Cloud Functions Invoker：允许调用函数。
  6. 依次点击继续和完成。

授予对 GCS 存储桶的 IAM 权限

  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 主题

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

创建 Cloud Run 函数以收集日志

  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 主题中，选择 forgerock-openidm-trigger。
    4. 点击保存。

  6. 在身份验证部分中：

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

  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 每个主题的页面数量上限

  10. 在请求部分中：

    • 请求超时时间：600 秒。

  11. 前往设置标签页：

    • 资源：512 MiB 内存、1 个 CPU。

  12. 点击创建。创建服务后，系统会打开内嵌代码编辑器。

添加函数代码

  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.
    """
    if not all([GCS_BUCKET, OPENIDM_BASE_URL, OPENIDM_USERNAME, OPENIDM_PASSWORD]):
        print('Error: Missing required environment variables')
        return

    try:
        bucket = storage_client.bucket(GCS_BUCKET)
        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):
    try:
        blob = bucket.blob(key)
        if blob.exists():
            return json.loads(blob.download_as_text())
    except Exception as e:
        print(f"Warning: Could not load state: {e}")
    return {}

def save_state(bucket, key, state):
    try:
        blob = bucket.blob(key)
        blob.upload_from_string(json.dumps(state, indent=2), content_type='application/json')
    except Exception as e:
        print(f"Warning: Could not save state: {e}")

def fetch_audit_logs(topic, topic_state):
    base_url = OPENIDM_BASE_URL.rstrip('/')
    all_events = []
    last_timestamp = topic_state.get('last_timestamp')
    query_filter = 'true' if not last_timestamp else 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'
            }

            headers = {
                'X-OpenIDM-Username': OPENIDM_USERNAME,
                'X-OpenIDM-Password': OPENIDM_PASSWORD,
                'Accept-API-Version': 'resource=1.0',
                'Accept': 'application/json'
            }

            response = http.request('GET', url, fields=params, headers=headers)
            if response.status != 200:
                print(f"API error for topic {topic}: {response.status}")
                break

            data = json.loads(response.data.decode('utf-8'))
            events = data.get('result', [])
            if not events:
                break

            all_events.extend(events)
            page_offset += PAGE_SIZE
            page_count += 1
            if len(events) < PAGE_SIZE:
                break
        except Exception as e:
            print(f"Error for topic {topic}: {str(e)}")
            break
    return all_events

def write_to_gcs(bucket, events):
    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])
    bucket.blob(filename).upload_from_string(ndjson_content, content_type='application/x-ndjson')
    • requirements.txt:
    functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

  3. 点击部署。部署需要 2-3 分钟。

创建 Cloud Scheduler 作业

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

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

    设置 值
    名称 forgerock-openidm-collector-hourly
    区域 选择与 Cloud Run 函数相同的区域
    频率 0 * * * *（每小时）
    时区 选择时区（建议选择 UTC）
    目标类型 Pub/Sub
    主题 forgerock-openidm-trigger
    消息正文 {}

  4. 点击创建。

时间表频率选项

频率 Cron 表达式 使用场景
每隔 5 分钟 */5 * * * * 大批量、低延迟
每小时 0 * * * * 标准（推荐）
每天 0 0 * * * 批量收集

测试集成

  1. 在 Cloud Scheduler 中，点击作业的强制运行。
  2. 在 Cloud Run 日志中验证运行情况。查找：Successfully processed X audit events。
  3. 确认 Cloud Storage 存储桶中的 openidm/ 文件夹下存在新的 json 文件。

检索 Google SecOps 服务账号

在 Google SecOps 中配置 Feed

  1. 依次前往 SIEM 设置 > Feed。
  2. 依次点击添加新 Feed > 配置单个 Feed。
  3. Feed 名称：ForgeRock OpenIDM Audit Logs。
  4. 来源类型：Google Cloud Storage V2。
  5. 日志类型：FORGEROCK_OPENIDM。
  6. 点击 Get Service Account，然后复制提供的电子邮件地址（例如 chronicle-12345...）。
  7. 点击下一步。
  8. 存储桶网址：gs://forgerock-openidm-audit-logs/openidm/。
  9. 来源删除选项：根据偏好设置选择（例如，从不）。
  10. 点击下一步，查看，然后点击提交。

授予 IAM 权限

  1. 依次前往 Cloud Storage > 存储分区。
  2. 选择您的存储桶，然后点击权限标签页。
  3. 点击授予访问权限。
  4. 添加主账号：粘贴 Google SecOps 服务账号电子邮件地址。
  5. 分配角色：选择 Storage Object Viewer。
  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
fluenttag_label、topic_label、context_roles_label additional.fields 上下文的键值对。
Via intermediary.hostname 代理/中介的主机名。
x_forwarded_ip，caller.callerIps intermediary.ip 中介的 IP。
timestamp metadata.event_timestamp 事件时间戳。
transactionId metadata.product_deployment_id 唯一交易 ID。
eventName metadata.product_event_type 来自 ForgeRock 的事件名称。
_id metadata.product_log_id 唯一日志标识符。
request_method network.http.method 所用的 HTTP 方法。
response.statusCode network.http.response_code HTTP 状态代码。
user_agent network.http.user_agent 完整的用户代理字符串。
client.ip，context.ipAddress principal.ip 执行者的来源 IP。
userId，principalData.0 principal.user.userid 执行操作的用户的 ID。
security_action security_result.action 已采取安全措施。
level security_result.severity 映射的严重级别。
server.ip target.ip 目标系统的 IP。
http.request.path target.url 目标网址/路径。
不适用 metadata.product_name 设置为 ForgeRock OpenIDM。
不适用 metadata.vendor_name 设置为 ForgeRock。
elapsed_time" and "X-Content-Type-Options additional.fields 从变更日志映射
trackingIds.0 metadata.product_log_id 从变更日志映射
context.userRolesProperty", "context.authenticationId", and "context.authenticationIdProperty principal.user.attribute.roles 从变更日志映射
context.component", "context.moduleId", and "context.queryId principal.resource.attribute.labels 从变更日志映射
context.roles", "_normalized.fieldNames", and "_eventId additional.fields 从变更日志映射

更新日志

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

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