Mengumpulkan log Privacy-i
Dokumen ini menjelaskan cara menyerap log Privacy-i ke Google Security Operations menggunakan Google Cloud Storage V2.
Privacy-i adalah platform pemantauan kepatuhan dan privasi data endpoint yang dikembangkan oleh Somansa (kini diakuisisi oleh Mitsui Bussan Secure Directions). Platform ini menyediakan penemuan, klasifikasi, dan penegakan kebijakan data sensitif di seluruh endpoint. Privacy-i REST API menyediakan akses terprogram ke log pemeriksaan, laporan insiden, dan data aktivitas agen.
Sebelum memulai
Pastikan Anda memiliki prasyarat berikut:
- Instance Google SecOps
- Project GCP dengan Cloud Storage API yang 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 administratif ke konsol pengelolaan Privacy-i
- Kredensial API (kunci API atau kredensial OAuth2) untuk Privacy-i REST API
Membuat bucket Google Cloud Storage
- Buka Konsol Google Cloud.
- Pilih project Anda atau buat project baru.
- Di menu navigasi, buka Cloud Storage > Buckets.
- Klik Create bucket.
Berikan detail konfigurasi berikut:
Setelan Nilai Memberi nama bucket Anda Masukkan nama yang unik secara global (misalnya, privacy-i-logs)Location type Pilih sesuai kebutuhan Anda (Region, Dual-region, Multi-region) Location Pilih lokasi (misalnya, us-central1)Storage class Standard (direkomendasikan untuk log yang sering diakses) Kontrol akses Seragam (direkomendasikan) Alat perlindungan Opsional: Mengaktifkan pembuatan versi objek atau kebijakan retensi Klik Create.
Mengumpulkan kredensial Privacy-i API
Mendapatkan kunci API
- Login ke konsol pengelolaan Privacy-i dengan kredensial administrator.
- Buka Settings > API Management (atau System > API Configuration).
- Klik Hasilkan Kunci API.
- Masukkan nama untuk kunci API (misalnya,
Google SecOps Integration). Salin dan simpan detail berikut di lokasi yang aman:
- Kunci API: Nilai kunci API yang dihasilkan
- Server URL: URL server pengelolaan Privacy-i (misalnya,
https://privacy-i.your-domain.com)
Menentukan URL dasar API
URL dasar Privacy-i API adalah URL server pengelolaan Anda:
| Format | Contoh |
|---|---|
| URL Server | https://privacy-i.your-domain.com/api |
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual credentials PRIVACY_I_API_KEY="your-api-key" PRIVACY_I_BASE_URL="https://privacy-i.your-domain.com/api" # Test API access - list recent events curl -s -X GET "${PRIVACY_I_BASE_URL}/v1/events?limit=1" \ -H "Authorization: Bearer ${PRIVACY_I_API_KEY}" \ -H "Accept: application/json"
Membuat akun layanan untuk fungsi Cloud Run
Fungsi Cloud Run memerlukan akun layanan dengan izin untuk menulis ke bucket GCS dan dipanggil oleh Pub/Sub.
Membuat akun layanan
- Di Konsol GCP, buka IAM & Admin > Service Accounts.
- Klik Create Service Account.
- Berikan detail konfigurasi berikut:
- Service account name: Masukkan
privacy-i-logs-collector-sa - Service account description: Masukkan
Service account for Cloud Run function to collect Privacy-i logs
- Service account name: Masukkan
- Klik Create and Continue.
- Di bagian Grant this service account access to project, tambahkan peran berikut:
- Klik Pilih peran.
- Telusuri dan pilih Storage Object Admin.
- Klik + Add another role.
- Telusuri dan pilih Cloud Run Invoker.
- Klik + Add another role.
- Telusuri dan pilih Cloud Functions Invoker.
- Klik Lanjutkan.
- Klik Done.
Peran ini diperlukan untuk:
- Storage Object Admin: Menulis log ke bucket GCS dan mengelola state file
- Cloud Run Invoker: Mengizinkan Pub/Sub memanggil fungsi
- Cloud Functions Invoker: Mengizinkan pemanggilan fungsi
Memberikan izin IAM di bucket GCS
Beri akun layanan izin tulis di bucket GCS:
- Buka Cloud Storage > Buckets.
- Klik nama bucket Anda (misalnya,
privacy-i-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
privacy-i-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com) - Assign roles: Pilih Storage Object Admin
- Tambahkan entitas: Masukkan email akun layanan (misalnya,
- Klik Simpan.
Membuat topik Pub/Sub
Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan di-subscribe oleh fungsi Cloud Run.
- Di Konsol GCP, buka Pub/Sub > Topics.
- Klik Create topic.
- Berikan detail konfigurasi berikut:
- ID Topik: Masukkan
privacy-i-logs-trigger - Biarkan setelan lainnya sesuai default
- ID Topik: Masukkan
- Klik Create.
Membuat fungsi Cloud Run untuk mengumpulkan log
Fungsi Cloud Run akan dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil log dari REST API Privacy-i dan menulisnya ke GCS.
- Di Konsol GCP, buka Cloud Run.
- Klik Create service.
- Pilih Function (gunakan editor inline untuk membuat fungsi).
Di bagian Configure, berikan detail konfigurasi berikut:
Setelan Nilai Nama layanan privacy-i-logs-collectorRegion Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)Runtime Pilih Python 3.12 atau yang lebih baru Di bagian Trigger (optional):
- Klik + Tambahkan pemicu.
- Pilih Cloud Pub/Sub.
- Di Select a Cloud Pub/Sub topic, pilih topik
privacy-i-logs-trigger. - Klik Simpan.
Di bagian Authentication:
- Pilih Wajibkan autentikasi.
- Periksa Identity and Access Management (IAM).
Scroll ke bawah dan luaskan Containers, Networking, Security.
Buka tab Keamanan:
- Service account: Pilih akun layanan
privacy-i-logs-collector-sa.
- Service account: Pilih akun layanan
Buka tab Penampung:
- Klik Variables & Secrets.
- Klik + Add variable untuk setiap variabel lingkungan:
Nama Variabel Nilai Contoh Deskripsi GCS_BUCKETprivacy-i-logsNama bucket GCS GCS_PREFIXprivacy-iAwalan untuk file log STATE_KEYprivacy-i/state.jsonJalur file status PRIVACY_I_API_KEYyour-api-keyKunci API Privacy-i PRIVACY_I_BASE_URLhttps://privacy-i.your-domain.com/apiURL dasar Privacy-i API MAX_RECORDS5000Data maksimum per operasi PAGE_SIZE1000Data per halaman LOOKBACK_HOURS24Periode lihat balik awal Di bagian Variables & Secrets, scroll ke bawah ke Requests:
- Request timeout: Masukkan
600detik (10 menit)
- Request timeout: Masukkan
Buka tab Setelan:
- Di bagian Resources:
- Memory: Pilih 512 MiB atau lebih tinggi
- CPU: Pilih 1
- Di bagian Resources:
Di bagian Revision scaling:
- Minimum number of instances: Masukkan
0 - Maximum number of instances: Masukkan
100(atau sesuaikan berdasarkan beban yang diharapkan)
- Minimum number of instances: Masukkan
Klik Create.
Tunggu hingga layanan dibuat (1-2 menit).
Setelah layanan dibuat, editor kode inline akan terbuka secara otomatis.
Menambahkan kode fungsi
- Masukkan main di kolom 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, timedelta 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() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'privacy-i') STATE_KEY = os.environ.get('STATE_KEY', 'privacy-i/state.json') PRIVACY_I_API_KEY = os.environ.get('PRIVACY_I_API_KEY') PRIVACY_I_BASE_URL = os.environ.get('PRIVACY_I_BASE_URL') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Privacy-i inspection and incident logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, PRIVACY_I_API_KEY, PRIVACY_I_BASE_URL]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) # Overlap by 2 minutes to catch any delayed events last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Fetch logs from multiple endpoints all_records = [] newest_event_time = None for endpoint_type in ['events', 'incidents']: records, newest_time = fetch_logs( endpoint_type=endpoint_type, start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) all_records.extend(records) if newest_time: if newest_event_time is None or parse_datetime(newest_time) > parse_datetime(newest_event_time): newest_event_time = newest_time if not all_records: print("No new log records found.") save_state(bucket, STATE_KEY, now.isoformat()) return # Write to GCS as NDJSON timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in all_records]) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(all_records)} records to gs://{GCS_BUCKET}/{object_key}") # Update state with newest event time if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(all_records)} records") 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: {e}") return {} def save_state(bucket, key, last_event_time_iso: str): """Save the last event timestamp to GCS state file.""" try: state = {'last_event_time': last_event_time_iso} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_time={last_event_time_iso}") except Exception as e: print(f"Warning: Could not save state: {e}") def fetch_logs(endpoint_type: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch logs from Privacy-i REST API with offset-based pagination and rate limiting. Args: endpoint_type: API endpoint type (events, incidents) start_time: Start time for log query end_time: End time for log query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (records list, newest_event_time ISO string) """ api_base = PRIVACY_I_BASE_URL.rstrip('/') endpoint = f"{api_base}/v1/{endpoint_type}" headers = { 'Authorization': f'Bearer {PRIVACY_I_API_KEY}', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-PrivacyICollector/1.0' } records = [] newest_time = None page_num = 0 offset = 0 backoff = 1.0 start_iso = start_time.strftime('%Y-%m-%dT%H:%M:%SZ') end_iso = end_time.strftime('%Y-%m-%dT%H:%M:%SZ') while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records}) for {endpoint_type}") break url = f"{endpoint}?startDate={start_iso}&endDate={end_iso}&limit={min(page_size, max_records - len(records))}&offset={offset}" try: response = http.request('GET', url, headers=headers) # Handle rate limiting with exponential backoff 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 records, newest_time data = json.loads(response.data.decode('utf-8')) page_results = data.get('data', data.get('results', data.get('items', []))) if not page_results: print(f"No more results (empty page) for {endpoint_type}") break print(f"{endpoint_type} page {page_num}: Retrieved {len(page_results)} events") # Add endpoint type for identification for event in page_results: event['_privacy_i_log_type'] = endpoint_type records.extend(page_results) # Track newest event time for event in page_results: try: event_ts = event.get('timestamp') or event.get('eventTime') or event.get('createdAt') if event_ts: event_time = str(event_ts) if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") # Check for more results total = data.get('total', data.get('totalCount', 0)) if total and (offset + len(page_results)) >= total: print(f"No more pages for {endpoint_type} (reached total)") break if len(page_results) < page_size: print(f"No more pages for {endpoint_type} (last page not full)") break offset += len(page_results) except Exception as e: print(f"Error fetching {endpoint_type} logs: {e}") return records, newest_time print(f"Retrieved {len(records)} total {endpoint_type} records from {page_num} pages") return records, newest_timeFile 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).
Buat tugas Cloud Scheduler
Cloud Scheduler akan memublikasikan pesan ke topik Pub/Sub secara berkala, sehingga memicu fungsi Cloud Run.
- Di Konsol GCP, buka Cloud Scheduler.
- Klik Create Job.
Berikan detail konfigurasi berikut:
Setelan Nilai Nama privacy-i-logs-collector-hourlyRegion Pilih region yang sama dengan fungsi Cloud Run Frekuensi 0 * * * *(setiap jam, tepat pada jamnya)Zona Waktu Pilih zona waktu (UTC direkomendasikan) Jenis target Pub/Sub Topik Pilih topik privacy-i-logs-triggerIsi pesan {}(objek JSON kosong)Klik Create.
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.
- Klik Force run untuk memicu tugas secara manual.
- Tunggu beberapa detik.
- Buka Cloud Run > Services.
- Klik
privacy-i-logs-collector. - Klik tab Logs.
Pastikan fungsi berhasil dieksekusi. Cari:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 events page 1: Retrieved X events incidents page 1: Retrieved X events Wrote X records to gs://privacy-i-logs/privacy-i/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsBuka Cloud Storage > Buckets.
Klik nama bucket Anda (
privacy-i-logs).Buka folder
privacy-i/.Pastikan file
.ndjsonbaru telah dibuat dengan stempel waktu saat ini.
Jika Anda melihat error di log:
- HTTP 401: Periksa kunci API di variabel lingkungan
- HTTP 403: Pastikan kunci API memiliki izin yang diperlukan di konsol pengelolaan Privacy-i
- HTTP 429: Pembatasan kapasitas - fungsi akan otomatis mencoba lagi dengan backoff
- Variabel lingkungan tidak ada: Pastikan semua variabel yang diperlukan telah ditetapkan
Mengonfigurasi feed di Google SecOps untuk menyerap log Privacy-i
- Buka Setelan > Pengelolaan Data > Feed. Jika Anda menggunakan platform khusus SIEM, buka Settings > Feeds.
- Klik Tambahkan Feed Berita Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
Privacy-i Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih Privacy-i sebagai Log type.
Klik Get Service Account. Email akun layanan yang unik akan ditampilkan, misalnya:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comSalin alamat email ini.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
Storage bucket URL: Masukkan URI bucket GCS dengan jalur awalan:
gs://privacy-i-logs/privacy-i/- Ganti:
privacy-i-logs: Nama bucket GCS Anda.privacy-i: Jalur awalan/folder opsional tempat log disimpan (biarkan kosong untuk root).
- Ganti:
Opsi penghapusan sumber: Pilih opsi penghapusan sesuai preferensi Anda:
- Never: Tidak pernah menghapus file apa pun setelah transfer (direkomendasikan untuk pengujian).
- Delete transferred files: Menghapus file setelah transfer berhasil.
Delete transferred files and empty directories: Menghapus file dan direktori kosong setelah transfer berhasil.
Usia File Maksimum: Sertakan file yang diubah dalam jumlah 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 berita baru Anda di layar Finalize, lalu klik Submit.
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.
- Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Add principals: Tempel email akun layanan Google SecOps
- Assign roles: Pilih Storage Object Viewer
- Klik Simpan.
Tabel pemetaan UDM
| Kolom Log | Pemetaan UDM | Logika |
|---|---|---|
| has_principal, has_target_file, has_user | metadata.event_type | Tetapkan ke SCAN_FILE jika has_principal dan has_target_file, atau USER_UNCATEGORIZED jika has_user, atau STATUS_UPDATE jika has_principal, atau GENERIC_EVENT |
| elog_incidentlogguid, efile_incidentlogguid, guid | metadata.product_log_id | Nilai dari elog_incidentlogguid jika tidak kosong, jika tidak, efile_incidentlogguid jika tidak kosong, jika tidak, guid |
| datatype | metadata.product_event_type | Nilai disalin langsung |
| productversion | metadata.product_version | Nilai disalin langsung |
| metadata.product_name | Setel ke "PRIVACY_I" | |
| metadata.vendor_name | Setel ke "PRIVACY_I" | |
| dfile_agentip, ip | principal.asset.ip | Digabungkan dari dfile_agentip jika tidak kosong, lalu ip jika tidak kosong |
| dfile_agentip, ip | principal.ip | Digabungkan dari dfile_agentip jika tidak kosong, lalu ip jika tidak kosong |
| dfile_computername | principal.asset.asset_id | Digabungkan sebagai "Computer:%{dfile_computername}" |
| computername | principal.asset.hostname | Digabungkan sebagai "Computer:%{computername}" |
| osserial_label, computerguid_label | principal.asset.attribute.labels | Digabungkan dari osserial_label dan computerguid_label |
| productid | principal.asset.product_object_id | Nilai disalin langsung |
| dlog_ostype, osname | principal.platform | Ditetapkan berdasarkan enum dlog_ostype (0=WINDOWS,1=LINUX,2=MAC), lalu ditimpa berdasarkan ekspresi reguler osname |
| macaddr | principal.mac | Digabungkan dari macaddr |
| dfile_userid, userid, admin_id | principal.user.userid | Ditetapkan ke dfile_userid, lalu ditimpa oleh userid jika tidak kosong, lalu oleh admin_id jika tidak kosong |
| dfile_username, empname, admin_name | principal.user.user_display_name | Ditetapkan ke dfile_username, lalu ditimpa oleh empname jika tidak kosong, lalu oleh admin_name jika tidak kosong |
| dfile_deptname | principal.user.department | Nilai disalin langsung |
| logintime | principal.user.last_login_time | Dikonversi menggunakan format tanggal yyyy-MM-dd HH:mm:ss |
| pekerjaan | principal.user.title | Nilai disalin langsung |
| dfile_patterninfo | security_result | Diekstrak dari JSON dan disusun ke dalam kolom deteksi |
| category | security_result.category_details | Nilai disalin langsung |
| logtype | security_result.action | Nilai disalin langsung |
| elog_detectedapplicationname | target.application | Nilai disalin langsung |
| dfile_filecreatedtime | target.file.create_time | Dikonversi menggunakan format tanggal ISO8601 |
| dfile_fileextension | target.file.mime_type | Nilai disalin langsung |
| dfile_filename | target.file.names | Digabungkan dari dfile_filename |
| dfile_filesize | target.file.size | Dikonversi ke bilangan bulat |
| dfile_firstscannedpath | target.file.full_path | Nilai disalin langsung |
| dfile_firstscannedtime | target.file.first_seen_time | Dikonversi menggunakan format tanggal ISO8601 |
| dfile_filemodifiedtime | target.file.last_modification_time | Dikonversi menggunakan format tanggal ISO8601 |
| efile_fileaccessedtime | target.file.last_access_time | Dikonversi menggunakan format tanggal yyyy-MM-dd HH:mm:ss |
| efile_resulttime | target.file.last_analysis_time | Dikonversi menggunakan format tanggal ISO8601 |
| efile_patternguid_label, dfile_dataformatname_label, dfile_filerelationguid_label, dfile_inspectcount_label, dfile_inspectendtime_label, dfile_inspectstarttime_label, dfile_inspectfilecount_label, dfile_inspectpropertycount_label, dfile_inspectpropertyfilecount_label, dfile_inspectlogtime_label, dfile_filetype_label, dlog_inspectinfo_label, dlog_inspectexaminationtype_label, dlog_inspecttype_label, dfile_encryptfiletype_label, dfile_scanlogtype_label, dfile_policyname_label, elog_mediaguid_label, elog_mediaid_label, loggroup_label, agent_id_label, logouttime_label, packageinstalledtime_label, registeredtime_label, detail_label | additional.fields | Digabungkan dari beberapa kolom label |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.