Mengumpulkan log PingOne Advanced Identity Cloud

Didukung di:

Google SecOps SIEM

Dokumen ini menjelaskan cara menyerap log PingOne Advanced Identity Cloud ke Google Security Operations menggunakan Google Cloud Storage. PingOne Advanced Identity Cloud adalah platform pengelolaan akses dan identitas yang menyediakan kemampuan autentikasi, otorisasi, dan pengelolaan pengguna untuk aplikasi berbasis cloud.

Sebelum memulai

Pastikan Anda memiliki prasyarat berikut:

Instance Google SecOps
Project GCP dengan Cloud Storage API diaktifkan
Izin untuk membuat dan mengelola bucket GCS
Izin untuk mengelola kebijakan IAM di bucket GCS
Izin untuk membuat layanan Cloud Run, topik Pub/Sub, dan tugas Cloud Scheduler
Akses istimewa ke tenant PingOne Advanced Identity Cloud

Mendapatkan kunci API PingOne dan FQDN tenant

Login ke konsol admin Advanced Identity Cloud.
Klik ikon pengguna > Tenant Settings.
Di tab Setelan Global, klik Log Kunci API.
Klik New Log API Key, lalu berikan nama untuk kunci.
Klik Buat Kunci.
Salin dan simpan nilai api_key_id dan api_key_secret di lokasi yang aman. Nilai api_key_secret tidak akan ditampilkan lagi.
Klik Selesai.
Buka Tenant Settings > Details, lalu temukan FQDN tenant Anda (misalnya, example.tomcat.pingone.com).

Catatan: PingOne Advanced Identity Cloud menyimpan log audit dan debug selama 30 hari. API tidak dapat mengambil data yang lebih lama dari periode retensi ini. Rencanakan frekuensi pengumpulan Anda dengan tepat.

Membuat bucket Google Cloud Storage

Buka Google Cloud Console.
Pilih project Anda atau buat project baru.
Di menu navigasi, buka Cloud Storage > Buckets.
Klik Create bucket.

Berikan detail konfigurasi berikut:

Setelan	Nilai
Beri nama bucket Anda	Masukkan nama yang unik secara global (misalnya, `pingone-aic-logs`)
Location type	Pilih berdasarkan kebutuhan Anda (Region, Dual-region, Multi-region)
Lokasi	Pilih lokasi (misalnya, `us-central1`)
Kelas penyimpanan	Standar (direkomendasikan untuk log yang sering diakses)
Access control	Seragam (direkomendasikan)
Alat perlindungan	Opsional: Aktifkan pembuatan versi objek atau kebijakan retensi

Klik Buat.

Buat akun layanan untuk Cloud Run Function

Fungsi Cloud Run memerlukan akun layanan dengan izin untuk menulis ke bucket GCS dan dipanggil oleh Pub/Sub.

Membuat akun layanan

Di GCP Console, buka IAM & Admin > Service Accounts.
Klik Create Service Account.
Berikan detail konfigurasi berikut:
- Nama akun layanan: Masukkan pingone-aic-collector-sa.
- Deskripsi akun layanan: Masukkan Service account for Cloud Run function to collect PingOne Advanced Identity Cloud logs.
Klik Create and Continue.
Di bagian Berikan akun layanan ini akses ke project, tambahkan peran berikut:
1. Klik Pilih peran.
2. Telusuri dan pilih Storage Object Admin.
3. Klik + Add another role.
4. Telusuri dan pilih Cloud Run Invoker.
5. Klik + Add another role.
6. Telusuri dan pilih Cloud Functions Invoker.
Klik Lanjutkan.
Klik Selesai.

Peran ini diperlukan untuk:

Storage Object Admin: Menulis log ke bucket GCS dan mengelola file status
Cloud Run Invoker: Mengizinkan Pub/Sub memanggil fungsi
Cloud Functions Invoker: Mengizinkan pemanggilan fungsi

Memberikan izin IAM pada bucket GCS

Beri akun layanan izin tulis di bucket GCS:

Buka Cloud Storage > Buckets.
Klik nama bucket Anda.
Buka tab Izin.
Klik Grant access.
Berikan detail konfigurasi berikut:
- Tambahkan prinsipal: Masukkan email akun layanan (misalnya, pingone-aic-collector-sa@PROJECT_ID.iam.gserviceaccount.com).
- Tetapkan peran: Pilih Storage Object Admin.
Klik Simpan.

Membuat topik Pub/Sub

Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan akan dilanggan oleh fungsi Cloud Run.

Di GCP Console, buka Pub/Sub > Topics.
Klik Create topic.
Berikan detail konfigurasi berikut:
- ID Topik: Masukkan pingone-aic-trigger.
- Biarkan setelan lainnya tetap default.
Klik Buat.

Membuat fungsi Cloud Run untuk mengumpulkan log

Fungsi Cloud Run dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil log dari PingOne Advanced Identity Cloud API dan menuliskannya ke GCS.

Di GCP Console, buka Cloud Run.
Klik Create service.
Pilih Function (gunakan editor inline untuk membuat fungsi).
Di bagian Konfigurasi, berikan detail konfigurasi berikut:

Setelan Nilai

Nama layanan pingone-aic-collector

Wilayah Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)

Runtime Pilih Python 3.12 atau yang lebih baru
Di bagian Pemicu (opsional):
1. Klik + Tambahkan pemicu.
2. Pilih Cloud Pub/Sub.
3. Di Select a Cloud Pub/Sub topic, pilih topik Pub/Sub (pingone-aic-trigger).
4. Klik Simpan.
Di bagian Authentication:
1. Pilih Wajibkan autentikasi.
2. Periksa Identity and Access Management (IAM).
Catatan: Pub/Sub secara otomatis menangani autentikasi saat memanggil fungsi.
Scroll ke bawah dan luaskan Containers, Networking, Security.
Buka tab Security:
- Akun layanan: Pilih akun layanan (pingone-aic-collector-sa).

Setelan	Nilai
Nama layanan	`pingone-aic-collector`
Wilayah	Pilih region yang cocok dengan bucket GCS Anda (misalnya, `us-central1`)
Runtime	Pilih Python 3.12 atau yang lebih baru

Buka tab Containers:

Klik Variables & Secrets.
Klik + Tambahkan variabel untuk setiap variabel lingkungan:

Nama Variabel	Nilai Contoh	Deskripsi
`GCS_BUCKET`	`pingone-aic-logs`	Nama bucket GCS
`GCS_PREFIX`	`pingone-aic/logs`	Awalan untuk file log
`STATE_KEY`	`pingone-aic/logs/state.json`	Jalur file status
`AIC_TENANT_FQDN`	`example.tomcat.pingone.com`	FQDN Tenant
`AIC_API_KEY_ID`	`your-api-key-id`	ID kunci API
`AIC_API_SECRET`	`your-api-key-secret`	Rahasia kunci API
`SOURCES`	`am-everything,idm-everything`	Sumber log yang dipisahkan koma (lihat catatan di bawah)
`PAGE_SIZE`	`500`	Data per halaman
`MAX_PAGES`	`20`	Halaman maksimum per proses
`LOOKBACK_SECONDS`	`3600`	Periode lihat balik awal

Di bagian Variabel & Secret, scroll ke Permintaan:
- Waktu tunggu permintaan: Masukkan 600 detik (10 menit).
Buka tab Setelan:
- Di bagian Materi:
  - Memori: Pilih 512 MiB atau yang lebih tinggi.
  - CPU: Pilih 1.
Di bagian Penskalaan revisi:
- Jumlah minimum instance: Masukkan 0.
- Jumlah maksimum instance: Masukkan 100 (atau sesuaikan berdasarkan perkiraan beban).
Klik Buat.
Tunggu hingga layanan dibuat (1-2 menit).
Setelah layanan dibuat, editor kode inline akan terbuka secara otomatis.

Menambahkan kode fungsi

Masukkan main di Function entry point

Di editor kode inline, buat dua file:

File pertama: 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))

File kedua: requirements.txt:

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

Klik Deploy untuk menyimpan dan men-deploy fungsi.
Tunggu hingga deployment selesai (2-3 menit).

Catatan: Konfigurasi pemicu Pub/Sub akan otomatis membuat langganan dan izin yang diperlukan.

Buat tugas Cloud Scheduler

Cloud Scheduler akan memublikasikan pesan ke topik Pub/Sub secara berkala, sehingga memicu fungsi Cloud Run.

Di GCP Console, buka Cloud Scheduler.
Klik Create Job.

Berikan detail konfigurasi berikut:

Setelan	Nilai
Nama	`pingone-aic-collector-hourly`
Wilayah	Pilih region yang sama dengan fungsi Cloud Run
Frekuensi	`0 * * * *` (setiap jam, tepat pada waktunya)
Zona waktu	Pilih zona waktu (UTC direkomendasikan)
Jenis target	Pub/Sub
Topik	Pilih topik Pub/Sub (`pingone-aic-trigger`)
Isi pesan	`{}` (objek JSON kosong)

Klik Buat.

Opsi frekuensi jadwal

Pilih frekuensi berdasarkan volume log dan persyaratan latensi:

Frekuensi	Ekspresi Cron	Kasus Penggunaan
Setiap 5 menit	`/5 * * *`	Volume tinggi, latensi rendah
Setiap 15 menit	`/15 * * *`	Volume sedang
Setiap jam	`0 * * * *`	Standar (direkomendasikan)
Setiap 6 jam	`0 /6 * *`	Volume rendah, pemrosesan batch
Harian	`0 0 * * *`	Pengumpulan data historis

Menguji integrasi

Di konsol Cloud Scheduler, temukan tugas Anda (pingone-aic-collector-hourly).
Klik Force run untuk memicu tugas secara manual.
Tunggu beberapa detik.
Buka Cloud Run > Services.
Klik nama fungsi (pingone-aic-collector).
Klik tab Logs.

Pastikan fungsi berhasil dieksekusi. Cari hal berikut:

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

Buka Cloud Storage > Buckets.
Klik nama bucket Anda (pingone-aic-logs).
Buka folder awalan (pingone-aic/logs/).
Pastikan file .json baru dibuat dengan stempel waktu saat ini.

Jika Anda melihat error dalam log:

HTTP 401: Periksa kredensial API di variabel lingkungan
HTTP 403: Pastikan akun memiliki izin yang diperlukan
HTTP 429: Pembatasan kecepatan - fungsi akan otomatis mencoba lagi dengan penundaan
Variabel lingkungan tidak ada: Periksa apakah semua variabel yang diperlukan telah ditetapkan

Mengambil akun layanan Google SecOps

Google SecOps menggunakan akun layanan unik untuk membaca data dari bucket GCS Anda. Anda harus memberi akun layanan ini akses ke bucket Anda.

Dapatkan email akun layanan

Buka Setelan SIEM > Feed.
Klik Tambahkan Feed Baru.
Klik Konfigurasi satu feed.
Di kolom Nama feed, masukkan nama untuk feed (misalnya, PingOne Advanced Identity Cloud).
Pilih Google Cloud Storage V2 sebagai Source type.
Pilih PingOne Advanced Identity Cloud sebagai Jenis log.
Klik Get Service Account. Email akun layanan yang unik akan ditampilkan, misalnya:
```
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
```
Salin alamat email ini untuk digunakan di langkah berikutnya.

Catatan: Setiap instance Google SecOps memiliki akun layanan yang unik. Jangan gunakan akun layanan dari dokumentasi atau contoh lain.

Memberikan izin IAM ke akun layanan Google SecOps

Akun layanan Google SecOps memerlukan peran Storage Object Viewer di bucket GCS Anda.

Buka Cloud Storage > Buckets.
Klik nama bucket Anda (pingone-aic-logs).
Buka tab Izin.
Klik Grant access.
Berikan detail konfigurasi berikut:
- Add principals: Tempel email akun layanan Google SecOps.
- Tetapkan peran: Pilih Storage Object Viewer.
Klik Simpan.

Catatan: Jika Anda berencana menggunakan opsi penghapusan "Hapus file yang ditransfer" atau "Hapus file yang ditransfer dan direktori kosong", berikan peran Storage Object Admin, bukan Storage Object Viewer.

Mengonfigurasi feed di Google SecOps untuk menyerap log PingOne Advanced Identity Cloud

Buka Setelan SIEM > Feed.
Klik Tambahkan Feed Baru.
Klik Konfigurasi satu feed.
Di kolom Nama feed, masukkan nama untuk feed (misalnya, PingOne Advanced Identity Cloud).
Pilih Google Cloud Storage V2 sebagai Source type.
Pilih PingOne Advanced Identity Cloud sebagai Jenis log.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
- URL bucket penyimpanan: Masukkan URI bucket GCS dengan jalur awalan:
```
gs://pingone-aic-logs/pingone-aic/logs/
```
  - Ganti:
    - pingone-aic-logs: Nama bucket GCS Anda.
    - pingone-aic/logs/: Awalan/jalur folder opsional tempat log disimpan.
  Catatan: Selalu sertakan garis miring (/) di akhir URI.
- Opsi penghapusan sumber: Pilih opsi penghapusan sesuai preferensi Anda:
  - Jangan pernah: Tidak pernah menghapus file apa pun setelah transfer (direkomendasikan untuk pengujian).
  - Hapus file yang ditransfer: Menghapus file setelah transfer berhasil.
  - Hapus file yang ditransfer dan direktori kosong: Menghapus file dan direktori kosong setelah transfer berhasil.
    
    Catatan: Jika Anda memilih opsi penghapusan, akun layanan harus memiliki peran Storage Object Admin, bukan Storage Object Viewer. Perbarui izin IAM yang sesuai.
- Usia File Maksimum: Menyertakan file yang diubah dalam beberapa hari terakhir. Defaultnya adalah 180 hari.
- Namespace aset: Namespace aset.
- Label penyerapan: Label yang akan diterapkan ke peristiwa dari feed ini.
Klik Berikutnya.
Tinjau konfigurasi feed baru Anda di layar Selesaikan, lalu klik Kirim.

Perlu bantuan lebih lanjut? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.