收集 OpenAI 稽核記錄
本文說明如何使用 Google Cloud Storage V2,將 OpenAI 稽核記錄擷取至 Google Security Operations。
OpenAI 為使用 OpenAI API 平台的機構提供稽核記錄 API。這項 API 會追蹤機構內的使用者動作和設定變更,包括 API 金鑰生命週期事件、使用者管理、專案變更、邀請、服務帳戶活動、登入和登出事件,以及機構設定變更。
事前準備
請確認您已完成下列事前準備事項:
- Google SecOps 執行個體
- 已啟用 Cloud Storage、Cloud Run、Pub/Sub 和 Cloud Scheduler API 的 GCP 專案
- 建立及管理 GCS bucket 的權限
- 管理 Google Cloud Storage 值區 IAM 政策的權限
- 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
- OpenAI API 平台機構中的機構擁有者角色
啟用 OpenAI 稽核記錄
您必須先在機構中啟用稽核記錄,才能存取稽核記錄。
- 前往 https://platform.openai.com 登入 OpenAI Platform。
- 依序前往「設定」>「機構」>「資料控管」。
- 向下捲動至「稽核記錄」部分。
- 按一下「稽核記錄」下方的「啟用」。
按一下 [儲存]。
建立 OpenAI 管理員 API 金鑰
- 前往 https://platform.openai.com 登入 OpenAI Platform。
- 按一下左側面板中的「管理金鑰」。
- 或者,您也可以直接前往 https://platform.openai.com/settings/organization/admin-keys。
- 按一下「建立新的管理員金鑰」。
- 在「Name」(名稱) 欄位中,輸入描述性名稱 (例如
Google SecOps Integration)。 - 點選「建立」。
請立即複製 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 值區
- 前往 Google Cloud Console。
- 選取專案或建立新專案。
- 在導覽選單中,依序前往「Cloud Storage」>「Bucket」。
- 按一下「建立值區」。
請提供下列設定詳細資料:
設定 值 為 bucket 命名 輸入全域不重複的名稱 (例如 openai-auditlog-logs)位置類型 根據需求選擇 (區域、雙區域、多區域) 位置 選取位置 (例如 us-central1)儲存空間級別 標準 (建議用於經常存取的記錄) 存取控管 統一 (建議) 保護工具 選用:啟用物件版本管理或資料保留政策 點選「建立」。
為 Cloud Run 函式建立服務帳戶
- 在 GCP 主控台中,依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
- 按一下「Create Service Account」(建立服務帳戶)。
- 請提供下列設定詳細資料:
- 服務帳戶名稱:輸入
openai-auditlog-collector-sa - 服務帳戶說明:輸入
Service account for Cloud Run function to collect OpenAI audit logs
- 服務帳戶名稱:輸入
- 按一下「建立並繼續」。
- 在「將專案存取權授予這個服務帳戶」部分,新增下列角色:
- 按一下「選擇角色」。
- 搜尋並選取「Storage 物件管理員」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Run Invoker」。
- 點選「+ 新增其他角色」。
- 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)。
- 按一下「繼續」。
- 按一下 [完成]。
授予 GCS 值區的 IAM 權限
- 依序前往「Cloud Storage」>「Buckets」。
- 按一下 bucket 名稱 (
openai-auditlog-logs)。 - 前往「權限」分頁標籤。
- 按一下「授予存取權」。
- 請提供下列設定詳細資料:
- 新增主體:輸入服務帳戶電子郵件地址 (
openai-auditlog-collector-sa@PROJECT_ID.iam.gserviceaccount.com) - 指派角色:選取「Storage 物件管理員」
- 新增主體:輸入服務帳戶電子郵件地址 (
- 按一下 [儲存]。
建立 Pub/Sub 主題
- 在 GCP Console 中,前往「Pub/Sub」>「Topics」(主題)。
- 按一下「建立主題」。
- 請提供下列設定詳細資料:
- 主題 ID:輸入
openai-auditlog-trigger - 其他設定保留預設值
- 主題 ID:輸入
- 點選「建立」。
建立 Cloud Run 函式來收集記錄
Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發,從 OpenAI 稽核記錄 API 擷取記錄,並寫入 GCS。
- 前往 GCP Console 的「Cloud Run」。
- 按一下「Create service」(建立服務)。
- 選取「函式」 (使用內嵌編輯器建立函式)。
在「設定」部分,提供下列設定詳細資料:
設定 值 服務名稱 openai-auditlog-collector區域 選取與 GCS bucket 相符的區域 (例如 us-central1)執行階段 選取 Python 3.12 以上版本 在「Trigger (optional)」(觸發條件 (選用)) 專區:
- 按一下「+ 新增觸發條件」。
- 選取「Cloud Pub/Sub」。
- 在「Select a Cloud Pub/Sub topic」(選取 Cloud Pub/Sub 主題) 中,選擇
openai-auditlog-trigger。 - 按一下 [儲存]。
在「Authentication」(驗證) 部分:
- 選取「需要驗證」。
- 檢查 Identity and Access Management (IAM)。
向下捲動並展開「Containers, Networking, Security」。
前往「安全性」分頁:
- 服務帳戶:選取
openai-auditlog-collector-sa
- 服務帳戶:選取
前往「容器」分頁:
- 按一下「變數與密鑰」。
- 針對每個環境變數,按一下「+ 新增變數」:
變數名稱 範例值 說明 GCS_BUCKETopenai-auditlog-logsGCS bucket 名稱 GCS_PREFIXopenai-auditlog記錄檔的前置字串 STATE_KEYopenai-auditlog/state.json狀態檔案路徑 OPENAI_ADMIN_KEYyour-admin-api-keyOpenAI Admin API 金鑰 MAX_RECORDS5000每次執行的記錄數上限 PAGE_SIZE100每個 API 頁面的記錄數 (最多 100 筆) LOOKBACK_HOURS24初始回溯期 在「變數與密鑰」部分,向下捲動至「要求」:
- 要求逾時:輸入
600秒 (10 分鐘)
- 要求逾時:輸入
前往「設定」分頁:
- 在「資源」部分:
- 記憶體:選取 512 MiB 以上
- CPU:選取 1
- 在「資源」部分:
在「修訂版本資源調度」部分:
- 執行個體數量下限:輸入
0 - 執行個體數量上限:輸入
100
- 執行個體數量下限:輸入
點選「建立」。
等待服務建立完成 (1 到 2 分鐘)。
服務建立完成後,系統會自動開啟內嵌程式碼編輯器。
新增函式程式碼
- 在「進入點」欄位中輸入 main。
在內嵌程式碼編輯器中建立兩個檔案:
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_atrequirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
點選「部署」即可儲存並部署函式。
等待部署作業完成 (2 到 3 分鐘)。
建立 Cloud Scheduler 工作
- 前往 GCP 主控台的「Cloud Scheduler」。
- 點選「建立工作」。
請提供下列設定詳細資料:
設定 值 名稱 openai-auditlog-collector-hourly區域 選取與 Cloud Run 函式相同的區域 頻率 0 * * * *(每小時整點)時區 選取時區 (建議使用世界標準時間) 目標類型 Pub/Sub 主題 選取「 openai-auditlog-trigger」郵件內文 {}(空白 JSON 物件)點選「建立」。
排程頻率選項
根據記錄檔量和延遲時間要求選擇頻率:
| 頻率 | Cron 運算式 | 用途 |
|---|---|---|
| 每 5 分鐘 | */5 * * * * |
高容量、低延遲 |
| 每 15 分鐘 | */15 * * * * |
中等音量 |
| 每小時 | 0 * * * * |
標準 (建議) |
| 每 6 小時 | 0 */6 * * * |
少量、批次處理 |
| 每日 | 0 0 * * * |
歷來資料集合 |
測試整合項目
- 在 Cloud Scheduler 控制台中,找出您的工作 (
openai-auditlog-collector-hourly)。 - 按一下「強制執行」即可手動觸發工作。
- 稍等幾秒鐘。
- 前往「Cloud Run」>「Services」。
- 按一下
openai-auditlog-collector。 - 按一下 [Logs] (記錄) 分頁標籤。
確認函式是否已順利執行。尋找:
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依序前往「Cloud Storage」>「Buckets」。
按一下
openai-auditlog-logs。前往
openai-auditlog/資料夾。確認是否已建立含有目前時間戳記的新
.ndjson檔案。
如果記錄中顯示錯誤:
- HTTP 401:確認
OPENAI_ADMIN_KEY環境變數正確無誤,且金鑰未遭撤銷 - HTTP 403:確認 API 金鑰是由機構擁有者建立的 Admin API 金鑰
- HTTP 429:頻率限制,函式會自動重試,並採用指數輪詢間隔
- 缺少環境變數:確認 Cloud Run 函式設定中已設定所有必要變數
擷取 Google SecOps 服務帳戶
- 依序前往「SIEM 設定」>「動態饋給」。
- 按一下「新增動態消息」。
- 按一下「設定單一動態饋給」。
- 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如
OpenAI Audit Logs)。 - 選取「Google Cloud Storage V2」做為「來源類型」。
選取「OpenAI 稽核記錄」做為「記錄類型」。按一下「取得服務帳戶」。系統會顯示專屬的服務帳戶電子郵件地址。例如:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com複製這個電子郵件地址,以便在下一步中使用。
點選「下一步」。
指定下列輸入參數的值:
儲存空間 bucket URL:輸入 GCS bucket URI,並加上前置路徑:
gs://openai-auditlog-logs/openai-auditlog/
- 來源刪除選項:根據偏好選取刪除選項:
- 永不:移轉後一律不刪除任何檔案 (建議用於測試)。
- 刪除已轉移的檔案:成功轉移檔案後刪除檔案。
- 刪除已轉移的檔案和空白目錄:成功轉移檔案後,刪除檔案和空白目錄。
- 檔案存在時間上限:包含在過去天數內修改的檔案 (預設為 180 天)
- 資產命名空間:資產命名空間
- 擷取標籤:要套用至這個動態饋給事件的標籤
點選「下一步」。
在「Finalize」(完成) 畫面中檢查新的動態饋給設定,然後按一下「Submit」(提交)。
將 IAM 權限授予 Google SecOps 服務帳戶
- 依序前往「Cloud Storage」>「Buckets」。
- 按一下
openai-auditlog-logs。 - 前往「權限」分頁標籤。
- 按一下「授予存取權」。
- 請提供下列設定詳細資料:
- 新增主體:貼上 Google SecOps 服務帳戶電子郵件地址
- 指派角色:選取「Storage 物件檢視者」
按一下 [儲存]。
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 專業人員尋求答案。