收集 PingOne Advanced Identity Cloud 記錄

支援的國家/地區:

本文說明如何使用 Google Cloud Storage,將 PingOne Advanced Identity Cloud 記錄擷取至 Google Security Operations。PingOne Advanced Identity Cloud 是身分與存取權管理平台,可為雲端應用程式提供驗證、授權和使用者管理功能。

事前準備

請確認您已完成下列事前準備事項:

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage API 的 GCP 專案
  • 建立及管理 GCS 值區的權限
  • 管理 Google Cloud Storage 值區 IAM 政策的權限
  • 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • PingOne Advanced Identity Cloud 租戶的特殊存取權

取得 PingOne API 金鑰和租戶 FQDN

  1. 登入 Advanced Identity Cloud 管理控制台。
  2. 依序點選使用者圖示 >「租戶設定」
  3. 在「全域設定」分頁中,按一下「記錄 API 金鑰」
  4. 按一下「New Log API Key」(新增記錄 API 金鑰),然後為金鑰命名。
  5. 按一下 [Create Key] (建立金鑰)
  6. 複製並儲存 api_key_idapi_key_secret 值,並妥善保存。系統不會再顯示 api_key_secret 值。
  7. 按一下 [完成]。
  8. 依序前往「租戶設定」>「詳細資料」,找出租戶 FQDN (例如 example.tomcat.pingone.com)。

建立 Google Cloud Storage 值區

  1. 前往 Google Cloud 控制台
  2. 選取專案或建立新專案。
  3. 在導覽選單中,依序前往「Cloud Storage」>「Bucket」
  4. 按一下「建立值區」
  5. 請提供下列設定詳細資料:

    設定
    為 bucket 命名 輸入全域不重複的名稱 (例如 pingone-aic-logs)
    位置類型 根據需求選擇 (區域、雙區域、多區域)
    位置 選取地點 (例如 us-central1)
    儲存空間級別 標準 (建議用於經常存取的記錄)
    存取控管 統一 (建議)
    保護工具 選用:啟用物件版本管理或保留政策
  6. 點選「建立」

為 Cloud Run 函式建立服務帳戶

Cloud Run 函式需要具備 GCS bucket 寫入權限的服務帳戶,並由 Pub/Sub 叫用。

建立服務帳戶

  1. GCP 主控台中,依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)
  2. 按一下 [Create Service Account] (建立服務帳戶)
  3. 請提供下列設定詳細資料:
    • 服務帳戶名稱:輸入 pingone-aic-collector-sa
    • 服務帳戶說明:輸入 Service account for Cloud Run function to collect PingOne Advanced Identity Cloud logs
  4. 按一下「建立並繼續」
  5. 在「將專案存取權授予這個服務帳戶」部分,新增下列角色:
    1. 按一下「選擇角色」
    2. 搜尋並選取「Storage 物件管理員」
    3. 點選「+ 新增其他角色」
    4. 搜尋並選取「Cloud Run Invoker」
    5. 點選「+ 新增其他角色」
    6. 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)
  6. 按一下「繼續」
  7. 按一下 [完成]。

這些角色適用於:

  • Storage 物件管理員:將記錄檔寫入 GCS 值區,並管理狀態檔案
  • Cloud Run 叫用者:允許 Pub/Sub 叫用函式
  • Cloud Functions 叫用者:允許函式叫用

授予 GCS 值區的 IAM 權限

授予服務帳戶 GCS bucket 的寫入權限:

  1. 依序前往「Cloud Storage」>「Buckets」
  2. 按一下 bucket 名稱。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」
  5. 請提供下列設定詳細資料:
    • 新增主體:輸入服務帳戶電子郵件地址 (例如 pingone-aic-collector-sa@PROJECT_ID.iam.gserviceaccount.com)。
    • 指派角色:選取「Storage 物件管理員」
  6. 按一下 [儲存]

建立 Pub/Sub 主題

建立 Pub/Sub 主題,Cloud Scheduler 會將訊息發布至該主題,而 Cloud Run 函式會訂閱該主題。

  1. GCP Console 中,前往「Pub/Sub」>「Topics」(主題)
  2. 按一下「建立主題」
  3. 請提供下列設定詳細資料:
    • 主題 ID:輸入 pingone-aic-trigger
    • 其他設定保留預設值。
  4. 點選「建立」

建立 Cloud Run 函式來收集記錄

Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發,從 PingOne Advanced Identity Cloud API 擷取記錄,並將記錄寫入 GCS。

  1. 前往 GCP Console 的「Cloud Run」
  2. 按一下「Create service」(建立服務)
  3. 選取「函式」 (使用內嵌編輯器建立函式)。
  4. 在「設定」部分,提供下列設定詳細資料:

    設定
    服務名稱 pingone-aic-collector
    區域 選取與 GCS bucket 相符的區域 (例如 us-central1)
    執行階段 選取「Python 3.12」以上版本
  5. 在「Trigger (optional)」(觸發條件 (選用)) 專區:

    1. 按一下「+ 新增觸發條件」
    2. 選取「Cloud Pub/Sub」
    3. 在「選取 Cloud Pub/Sub 主題」中,選擇 Pub/Sub 主題 (pingone-aic-trigger)。
    4. 按一下 [儲存]
  6. 在「Authentication」(驗證) 部分:

    1. 選取「需要驗證」
    2. 檢查 Identity and Access Management (IAM)
  7. 向下捲動並展開「Containers, Networking, Security」

  8. 前往「安全性」分頁:

    • 服務帳戶:選取服務帳戶 (pingone-aic-collector-sa)。
  9. 前往「容器」分頁:

    1. 按一下「變數與密鑰」
    2. 針對每個環境變數,按一下「+ 新增變數」
    變數名稱 範例值 說明
    GCS_BUCKET pingone-aic-logs GCS bucket 名稱
    GCS_PREFIX pingone-aic/logs 記錄檔的前置字串
    STATE_KEY pingone-aic/logs/state.json 狀態檔案路徑
    AIC_TENANT_FQDN example.tomcat.pingone.com 租戶 FQDN
    AIC_API_KEY_ID your-api-key-id API 金鑰 ID
    AIC_API_SECRET your-api-key-secret API 金鑰 Secret
    SOURCES am-everything,idm-everything 以半形逗號分隔的記錄來源 (請參閱下方附註)
    PAGE_SIZE 500 每頁記錄數
    MAX_PAGES 20 每次執行的頁數上限
    LOOKBACK_SECONDS 3600 初始回溯期
  10. 在「變數與 Secret」部分,捲動至「要求」

    • 要求逾時:輸入 600 秒 (10 分鐘)。
  11. 前往「設定」分頁:

    • 在「資源」部分:
      • 記憶體:選取 512 MiB 以上。
      • CPU:選取 1
  12. 在「修訂版本資源調度」部分:

    • 執行個體數量下限:輸入 0
    • 「Maximum number of instances」(執行個體數量上限):輸入 100 (或根據預期負載調整)。
  13. 點選「建立」

  14. 等待服務建立完成 (1 到 2 分鐘)。

  15. 服務建立完成後,系統會自動開啟內嵌程式碼編輯器

新增函式程式碼

  1. 在「Function entry point」(函式進入點) 中輸入 main
  2. 在內嵌程式碼編輯器中建立兩個檔案:

    • 第一個檔案:main.py:
    import functions_framework
    from google.cloud import storage
    import json
    import os
    import urllib3
    from datetime import datetime, timezone
    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()
    
    @functions_framework.cloud_event
    def main(cloud_event):
        """
        Cloud Run function triggered by Pub/Sub to fetch logs from PingOne Advanced Identity Cloud API and write to GCS.
    
        Args:
            cloud_event: CloudEvent object containing Pub/Sub message
        """
    
        # Get environment variables
        bucket_name = os.environ.get('GCS_BUCKET')
        prefix = os.environ.get('GCS_PREFIX', 'pingone-aic/logs')
        state_key = os.environ.get('STATE_KEY', 'pingone-aic/logs/state.json')
    
        fqdn = os.environ.get('AIC_TENANT_FQDN', '').strip('/')
        api_key_id = os.environ.get('AIC_API_KEY_ID')
        api_key_secret = os.environ.get('AIC_API_SECRET')
    
        sources = [s.strip() for s in os.environ.get('SOURCES', 'am-everything,idm-everything').split(',') if s.strip()]
        page_size = min(int(os.environ.get('PAGE_SIZE', '500')), 1000)
        max_pages = int(os.environ.get('MAX_PAGES', '20'))
        lookback_seconds = int(os.environ.get('LOOKBACK_SECONDS', '3600'))
    
        if not all([bucket_name, fqdn, api_key_id, api_key_secret]):
            print('Error: Missing required environment variables')
            return
    
        try:
            # Get GCS bucket
            bucket = storage_client.bucket(bucket_name)
    
            # Load state
            state = load_state(bucket, state_key)
            state.setdefault('sources', {})
    
            summary = []
    
            for source in sources:
                last_ts = state['sources'].get(source, {}).get('last_ts')
                res = fetch_source(bucket, prefix, fqdn, api_key_id, api_key_secret, source, last_ts, page_size, max_pages, lookback_seconds)
    
                if res.get('newest_ts'):
                    state['sources'][source] = {'last_ts': res['newest_ts']}
    
                summary.append(res)
    
            # Save state
            save_state(bucket, state_key, state)
    
            print(f'Successfully processed logs: {json.dumps(summary)}')
    
        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: {str(e)}')
        return {'sources': {}}
    
    def save_state(bucket, key, state):
        """Save state to GCS."""
        try:
            blob = bucket.blob(key)
            blob.upload_from_string(
                json.dumps(state, separators=(',', ':')),
                content_type='application/json'
            )
        except Exception as e:
            print(f'Warning: Could not save state: {str(e)}')
    
    def fetch_source(bucket, prefix, fqdn, api_key_id, api_key_secret, source, last_ts, page_size, max_pages, lookback_seconds):
        """Fetch logs for a specific source."""
        base_url = f"https://{fqdn}/monitoring/logs"
        now = time.time()
    
        begin_time = bounded_begin_time(last_ts, now, lookback_seconds)
    
        params = {
            'source': source,
            '_pageSize': str(page_size),
            '_sortKeys': 'timestamp',
            'beginTime': begin_time
        }
    
        headers = {
            'x-api-key': api_key_id,
            'x-api-secret': api_key_secret
        }
    
        pages = 0
        written = 0
        newest_ts = last_ts
        cookie = None
    
        while pages < max_pages:
            if cookie:
                params['_pagedResultsCookie'] = cookie
    
            # Build query string
            query_parts = [f"{k}={v}" for k, v in params.items()]
            query_string = '&'.join(query_parts)
            url = f"{base_url}?{query_string}"
    
            # Make request with retry logic
            data = http_get_with_retry(url, headers)
    
            # Write page to GCS
            write_page(bucket, prefix, data, source)
    
            # Process results
            results = data.get('result') or data.get('results') or []
            for item in results:
                t = item.get('timestamp') or item.get('payload', {}).get('timestamp')
                if t and (newest_ts is None or t > newest_ts):
                    newest_ts = t
    
            written += len(results)
            cookie = data.get('pagedResultsCookie')
            pages += 1
    
            if not cookie:
                break
    
        return {
            'source': source,
            'pages': pages,
            'written': written,
            'newest_ts': newest_ts
        }
    
    def http_get_with_retry(url, headers, timeout=60, max_retries=5):
        """Make HTTP GET request with retry logic."""
        attempt = 0
        backoff = 1.0
    
        while True:
            try:
                response = http.request('GET', url, headers=headers, timeout=timeout)
    
                if response.status == 429 and attempt < max_retries:
                    # Rate limited - check for X-RateLimit-Reset header
                    reset_header = response.headers.get('X-RateLimit-Reset')
                    if reset_header:
                        delay = max(1, int(reset_header) - int(time.time()))
                    else:
                        delay = int(backoff)
    
                    print(f'Rate limited, waiting {delay} seconds')
                    time.sleep(delay)
                    attempt += 1
                    backoff *= 2
                    continue
    
                if 500 <= response.status < 600 and attempt < max_retries:
                    print(f'Server error {response.status}, retrying in {backoff} seconds')
                    time.sleep(backoff)
                    attempt += 1
                    backoff *= 2
                    continue
    
                if response.status != 200:
                    raise Exception(f'HTTP {response.status}: {response.data.decode("utf-8")}')
    
                return json.loads(response.data.decode('utf-8'))
    
            except Exception as e:
                if attempt < max_retries:
                    print(f'Request failed: {str(e)}, retrying in {backoff} seconds')
                    time.sleep(backoff)
                    attempt += 1
                    backoff *= 2
                    continue
                raise
    
    def write_page(bucket, prefix, payload, source):
        """Write a page of logs to GCS."""
        ts = datetime.now(timezone.utc)
        blob_name = f"{prefix}/{ts.strftime('%Y/%m/%d/%H%M%S')}-pingone-aic-{source}.json"
    
        blob = bucket.blob(blob_name)
        blob.upload_from_string(
            json.dumps(payload, separators=(',', ':')),
            content_type='application/json'
        )
    
        print(f'Wrote logs to {blob_name}')
    
    def bounded_begin_time(last_ts, now, lookback_seconds):
        """Calculate begin time bounded by 24 hour limit."""
        twenty_four_h_ago = now - 24 * 3600
    
        if last_ts:
            try:
                # Parse ISO timestamp
                t_struct = time.strptime(last_ts[:19] + 'Z', '%Y-%m-%dT%H:%M:%SZ')
                t_epoch = int(time.mktime(t_struct))
            except Exception:
                t_epoch = int(now - lookback_seconds)
    
            begin_epoch = max(t_epoch, int(twenty_four_h_ago))
        else:
            begin_epoch = max(int(now - lookback_seconds), int(twenty_four_h_ago))
    
        return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(begin_epoch))
    
    • 第二個檔案:requirements.txt:
    functions-framework==3.*
    google-cloud-storage==2.*
    urllib3>=2.0.0
    
  3. 點選「部署」來儲存並部署函式。

  4. 等待部署作業完成 (2 到 3 分鐘)。

建立 Cloud Scheduler 工作

Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題,觸發 Cloud Run 函式。

  1. 前往 GCP 主控台的「Cloud Scheduler」
  2. 點選「建立工作」
  3. 請提供下列設定詳細資料:

    設定
    名稱 pingone-aic-collector-hourly
    區域 選取與 Cloud Run 函式相同的區域
    頻率 0 * * * * (每小時整點)
    時區 選取時區 (建議使用世界標準時間)
    目標類型 Pub/Sub
    主題 選取 Pub/Sub 主題 (pingone-aic-trigger)
    郵件內文 {} (空白 JSON 物件)
  4. 點選「建立」

排程頻率選項

  • 根據記錄檔量和延遲時間要求選擇頻率:

    頻率 Cron 運算式 用途
    每 5 分鐘 */5 * * * * 高容量、低延遲
    每 15 分鐘檢查一次 */15 * * * * 普通量
    每小時 0 * * * * 標準 (建議採用)
    每 6 小時 0 */6 * * * 少量、批次處理
    每日 0 0 * * * 歷來資料集合

測試整合項目

  1. Cloud Scheduler 控制台中,找出您的作業 (pingone-aic-collector-hourly)。
  2. 按一下「強制執行」,手動觸發工作。
  3. 稍等幾秒鐘。
  4. 前往「Cloud Run」>「Services」
  5. 按一下函式名稱 (pingone-aic-collector)。
  6. 按一下 [Logs] (記錄) 分頁標籤。
  7. 確認函式是否已順利執行。請找出以下項目:

    Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
    Page 1: Retrieved X events
    Wrote logs to gs://bucket-name/prefix/logs_YYYYMMDD_HHMMSS.json
    Successfully processed X records
    
  8. 依序前往「Cloud Storage」>「Buckets」

  9. 按一下 bucket 名稱 (pingone-aic-logs)。

  10. 前往前置字元資料夾 (pingone-aic/logs/)。

  11. 確認是否已建立含有目前時間戳記的新 .json 檔案。

如果在記錄中發現錯誤:

  • HTTP 401:檢查環境變數中的 API 憑證
  • HTTP 403:確認帳戶是否具備必要權限
  • HTTP 429:頻率限制 - 函式會自動重試並延遲
  • 缺少環境變數:檢查是否已設定所有必要變數

擷取 Google SecOps 服務帳戶

Google SecOps 會使用專屬服務帳戶,從 GCS bucket 讀取資料。您必須授予這個服務帳戶值區存取權。

取得服務帳戶電子郵件地址

  1. 依序前往「SIEM 設定」>「動態饋給」
  2. 按一下「新增動態消息」
  3. 按一下「設定單一動態饋給」
  4. 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如 PingOne Advanced Identity Cloud)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」
  6. 選取「PingOne Advanced Identity Cloud」做為「記錄類型」
  7. 按一下「取得服務帳戶」。系統會顯示專屬的服務帳戶電子郵件地址,例如:

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
    
  8. 複製這個電子郵件地址,以便在下一步中使用。

將 IAM 權限授予 Google SecOps 服務帳戶

Google SecOps 服務帳戶需要 GCS bucket 的「Storage 物件檢視者」角色。

  1. 依序前往「Cloud Storage」>「Buckets」
  2. 按一下 bucket 名稱 (pingone-aic-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」
  5. 請提供下列設定詳細資料:
    • 新增主體:貼上 Google SecOps 服務帳戶電子郵件地址。
    • 指派角色:選取「Storage 物件檢視者」
  6. 按一下 [儲存]

在 Google SecOps 中設定資訊提供,以便擷取 PingOne Advanced Identity Cloud 記錄

  1. 依序前往「SIEM 設定」>「動態饋給」
  2. 按一下「新增動態消息」
  3. 按一下「設定單一動態饋給」
  4. 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如 PingOne Advanced Identity Cloud)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」
  6. 選取「PingOne Advanced Identity Cloud」做為「記錄類型」
  7. 點選 [下一步]。
  8. 指定下列輸入參數的值:

    • 儲存空間 bucket URL:輸入 GCS bucket URI,並加上前置路徑:

      gs://pingone-aic-logs/pingone-aic/logs/
      
      • 取代:

        • pingone-aic-logs:您的 GCS bucket 名稱。
        • pingone-aic/logs/:儲存記錄的選用前置字元/資料夾路徑。
    • 來源刪除選項:根據偏好設定選取刪除選項:

      • 永不:移轉後一律不刪除任何檔案 (建議用於測試)。
      • 刪除已轉移的檔案:成功轉移檔案後刪除檔案。
      • 刪除已轉移的檔案和空白目錄:成功轉移後刪除檔案和空白目錄。

    • 檔案存在時間上限:包含在過去天數內修改的檔案。預設值為 180 天。

    • 資產命名空間資產命名空間

    • 擷取標籤:要套用至這個動態饋給事件的標籤。

  9. 點選 [下一步]。

  10. 在「Finalize」(完成) 畫面中檢查新的動態饋給設定,然後按一下「Submit」(提交)

需要其他協助嗎?向社群成員和 Google SecOps 專業人員尋求答案。