收集 OpenAI 审核日志

支持的平台：

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

OpenAI 为使用 OpenAI API 平台的组织提供了 Audit Logs API。该 API 会跟踪组织内的用户操作和配置更改，包括 API 密钥生命周期事件、用户管理、项目更改、邀请、服务账号活动、登录和退出事件，以及组织配置更改。

准备工作

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

  • Google SecOps 实例
  • 启用了 Cloud Storage、Cloud Run、Pub/Sub 和 Cloud Scheduler API 的 GCP 项目
  • 创建和管理 GCS 存储分区的权限
  • 管理 GCS 存储分区的 IAM 政策的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 您在 OpenAI API 平台组织中的“组织所有者”角色

启用 OpenAI 审核日志记录

您必须先在组织中启用审核日志记录，然后才能访问审核日志。

  1. 前往 https://platform.openai.com 并登录 OpenAI 平台。
  2. 依次前往设置 > 组织 > 数据控制。
  3. 向下滚动到审核日志记录部分。
  4. 点击审核日志记录下的启用。

  5. 点击保存。

创建 OpenAI Admin API 密钥

  1. 前往 https://platform.openai.com 并登录 OpenAI 平台。
  2. 在左侧面板中，点击管理员密钥。
  3. 或者，您也可以直接前往 https://platform.openai.com/settings/organization/admin-keys。
  4. 点击创建新的管理员密钥。
  5. 在名称字段中，输入一个描述性名称（例如 Google SecOps Integration）。
  6. 点击创建。

  7. 立即复制 API 密钥并妥善存储。

测试 API 访问权限

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

    # Replace with your actual Admin API key
OPENAI_ADMIN_KEY="your-admin-api-key"

# Test audit logs API access
curl -s -H "Authorization: Bearer ${OPENAI_ADMIN_KEY}" \
    -H "Content-Type: application/json" \
    "https://api.openai.com/v1/organization/audit_logs?limit=5" \
    | python3 -m json.tool

如果响应成功，则会返回一个 JSON 对象，其中 object 字段设置为 list，并且 data 数组包含审核日志条目。

创建 Google Cloud Storage 存储分区

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

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

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

  6. 点击创建。

为 Cloud Run 函数创建服务账号

  1. 在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
  2. 点击创建服务账号。
  3. 提供以下配置详细信息：
    • 服务账号名称：输入 openai-auditlog-collector-sa
    • 服务账号说明：输入 Service account for Cloud Run function to collect OpenAI audit logs
  4. 点击创建并继续。
  5. 在向此服务账号授予对项目的访问权限部分中，添加以下角色：
    1. 点击选择角色。
    2. 搜索并选择 Storage Object Admin。
    3. 点击 + 添加其他角色。
    4. 搜索并选择 Cloud Run Invoker。
    5. 点击 + 添加其他角色。
    6. 搜索并选择 Cloud Functions Invoker。
  6. 点击继续。
  7. 点击完成。

授予对 GCS 存储桶的 IAM 权限

  1. 前往 Cloud Storage > 存储分区。
  2. 点击您的存储桶名称 (openai-auditlog-logs)。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：输入服务账号电子邮件地址 (openai-auditlog-collector-sa@PROJECT_ID.iam.gserviceaccount.com)
    • 分配角色：选择 Storage Object Admin
  6. 点击保存。

创建发布/订阅主题

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

创建 Cloud Run 函数以收集日志

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

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

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

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

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

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

  6. 在身份验证部分中：

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

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

  8. 前往安全性标签页：

    • 服务账号：选择 openai-auditlog-collector-sa

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击+ 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET openai-auditlog-logs GCS 存储桶名称
    GCS_PREFIX openai-auditlog 日志文件的前缀
    STATE_KEY openai-auditlog/state.json 状态文件路径
    OPENAI_ADMIN_KEY your-admin-api-key OpenAI Admin API 密钥
    MAX_RECORDS 5000 每次运行的记录数上限
    PAGE_SIZE 100 每个 API 页面的记录数（最多 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

http = urllib3.PoolManager(
  timeout=urllib3.Timeout(connect=5.0, read=30.0),
  retries=False,
)

storage_client = storage.Client()

GCS_BUCKET = os.environ.get('GCS_BUCKET')
GCS_PREFIX = os.environ.get('GCS_PREFIX', 'openai-auditlog')
STATE_KEY = os.environ.get('STATE_KEY', 'openai-auditlog/state.json')
OPENAI_ADMIN_KEY = os.environ.get('OPENAI_ADMIN_KEY')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100'))
LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24'))

API_BASE = 'https://api.openai.com'
AUDIT_LOGS_ENDPOINT = '/v1/organization/audit_logs'

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

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

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

  try:
    bucket = storage_client.bucket(GCS_BUCKET)
    state = load_state(bucket)
    now = datetime.now(timezone.utc)

    if isinstance(state, dict) and state.get('last_effective_at'):
      try:
        last_effective_at = int(state['last_effective_at'])
        last_time = datetime.fromtimestamp(last_effective_at, tz=timezone.utc)
        last_time = last_time - timedelta(minutes=2)
      except Exception as e:
        print(f"Warning: Could not parse last_effective_at: {e}")
        last_time = now - timedelta(hours=LOOKBACK_HOURS)
    else:
      last_time = now - timedelta(hours=LOOKBACK_HOURS)

    start_unix = int(last_time.timestamp())
    end_unix = int(now.timestamp())

    print(f"Fetching audit logs from {last_time.isoformat()} to {now.isoformat()}")

    records, newest_effective_at = fetch_audit_logs(
      start_unix=start_unix,
      end_unix=end_unix,
      page_size=PAGE_SIZE,
      max_records=MAX_RECORDS,
    )

    if not records:
      print("No new audit log records found.")
      save_state(bucket, end_unix)
      return

    timestamp = now.strftime('%Y%m%d_%H%M%S')
    object_key = f"{GCS_PREFIX}/openai_auditlog_{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}")

    if newest_effective_at:
      save_state(bucket, newest_effective_at)
    else:
      save_state(bucket, end_unix)

    print(f"Successfully processed {len(records)} records")

  except Exception as e:
    print(f'Error processing audit logs: {str(e)}')
    raise

def load_state(bucket):
  """Load state from GCS."""
  try:
    blob = bucket.blob(STATE_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, last_effective_at):
  """Save the last effective_at Unix timestamp to GCS state file."""
  try:
    state = {
      'last_effective_at': last_effective_at,
      'last_run': datetime.now(timezone.utc).isoformat()
    }
    blob = bucket.blob(STATE_KEY)
    blob.upload_from_string(
      json.dumps(state, indent=2),
      content_type='application/json'
    )
    print(f"Saved state: last_effective_at={last_effective_at}")
  except Exception as e:
    print(f"Warning: Could not save state: {e}")

def fetch_audit_logs(start_unix, end_unix, page_size, max_records):
  """
  Fetch audit logs from the OpenAI API with pagination and rate limiting.

  Args:
    start_unix: Start time as Unix seconds
    end_unix: End time as Unix seconds
    page_size: Number of records per page (max 100)
    max_records: Maximum total records to fetch

  Returns:
    Tuple of (records list, newest effective_at Unix timestamp)
  """
  headers = {
    'Authorization': f'Bearer {OPENAI_ADMIN_KEY}',
    'Content-Type': 'application/json',
  }

  records = []
  newest_effective_at = None
  page_num = 0
  backoff = 1.0
  cursor = None

  while True:
    page_num += 1

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

    params = []
    params.append(f"effective_at[gte]={start_unix}")
    params.append(f"effective_at[lte]={end_unix}")
    params.append(f"limit={min(page_size, max_records - len(records))}")
    if cursor:
      params.append(f"after={cursor}")

    url = f"{API_BASE}{AUDIT_LOGS_ENDPOINT}?{'&'.join(params)}"

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

      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('data', [])

      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)

      for event in page_results:
        try:
          effective_at = event.get('effective_at')
          if effective_at is not None:
            if newest_effective_at is None or effective_at > newest_effective_at:
              newest_effective_at = effective_at
        except Exception as e:
          print(f"Warning: Could not parse event time: {e}")

      has_more = data.get('has_more', False)
      if not has_more:
        print("No more pages (has_more=false)")
        break

      last_id = data.get('last_id')
      if not last_id:
        print("No more pages (no last_id)")
        break

      cursor = last_id

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

  print(f"Retrieved {len(records)} total records from {page_num} pages")
  return records, newest_effective_at

    • requirements.txt:

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

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

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

创建 Cloud Scheduler 作业

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

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

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

  4. 点击创建。

时间表频率选项

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

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

测试集成

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

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

    Fetching audit logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
Page 1: Retrieved X events
Wrote X records to gs://openai-auditlog-logs/openai-auditlog/openai_auditlog_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

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

  9. 点击 openai-auditlog-logs。

  10. 转到 openai-auditlog/ 文件夹。

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

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

  • HTTP 401：验证 OPENAI_ADMIN_KEY 环境变量是否正确，以及密钥是否已被撤消
  • HTTP 403：验证 API 密钥是否为组织所有者创建的 Admin API 密钥
  • HTTP 429：速率限制 - 函数将自动重试，并采用指数退避算法
  • 缺少环境变量：验证是否已在 Cloud Run 函数配置中设置所有必需的变量

检索 Google SecOps 服务账号

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

  6. 选择 OpenAI 审核日志作为日志类型。点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址。例如：

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

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

  8. 点击下一步。

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

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

      gs://openai-auditlog-logs/openai-auditlog/
    • 来源删除选项：根据您的偏好选择删除选项：
      • 永不：转移后永不删除任何文件（建议用于测试）。
      • 删除已转移的文件：在成功转移后删除文件。
      • 删除已转移的文件和空目录：成功转移后删除文件和空目录。
    • 文件存在时间上限：包含在过去指定天数内修改的文件（默认值为 180 天）
    • 资产命名空间：资产命名空间
    • 注入标签：要应用于此 Feed 中事件的标签

  10. 点击下一步。

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

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

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

  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
actor.session.ip_address_details.region_code additional.fields 合并为键值对
actor.session.ip_address_details.asn additional.fields
effective_at metadata.event_timestamp 从 UNIX 时间戳转换而来
has_principal metadata.event_type 如果 has_principal 为 true，则设置为“STATUS_UPDATE”；如果 has_principal 和 has_target 均为 true，则设置为“NETWORK_CONNECTION”；如果 has_principal、has_file 和 has_source_file 均为 true，则设置为“FILE_COPY”；如果 has_principal 和 has_file 均为 true，则设置为“FILE_UNCATEGORIZED”；如果 has_user 为 true，则设置为“USER_UNCATEGORIZED”；否则设置为“GENERIC_EVENT”
has_user metadata.event_type
has_target metadata.event_type
has_file metadata.event_type
has_source_file metadata.event_type
actor.session.user_agent network.http.parsed_user_agent 直接复制并转换为已解析的用户代理的值
actor.session.ja3 network.tls.client.ja3 直接复制值
actor.session.ip_address principal.asset.ip 直接复制值
actor.session.ip_address principal.ip 直接复制值
actor.session.ip_address_details.city principal.location.city 直接复制值
actor.session.ip_address_details.country principal.location.country_or_region 直接复制值
actor.session.ip_address_details.latitude principal.location.region_latitude 已转换为浮点数
actor.session.ip_address_details.longitude principal.location.region_longitude 已转换为浮点数
actor.session.ip_address_details.region principal.location.state 直接复制值
actor.session.user.email principal.user.email_addresses 直接复制值
actor.session.user.id principal.user.userid 使用 grok 模式提取
actor.session.ja4 security_result.detection_fields 合并为键为“ja4”的键值对
类型 security_result.summary 直接复制值
metadata.product_name metadata.product_name 设置为“OPENAI_AUDITLOG”
metadata.vendor_name metadata.vendor_name 设置为“OPENAI_AUDITLOG”

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