Mengumpulkan log SpyCloud
Dokumen ini menjelaskan cara menyerap log SpyCloud ke Google Security Operations menggunakan Google Cloud Storage V2.
SpyCloud adalah platform pencegahan pengambilalihan akun yang menyediakan intelijen kredensial curian dan pelanggaran. API ini mengirimkan catatan pelanggaran, pemberitahuan daftar pantauan, dan laporan kredensial yang disusupi melalui REST API.
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
- Akun SpyCloud dengan akses API dan kunci API yang valid
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 Beri nama bucket Anda Masukkan nama yang unik secara global (misalnya, spycloud-logs)Location type Pilih berdasarkan kebutuhan Anda (Region, Dual-region, Multi-region) Location 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 Create.
Kumpulkan kredensial SpyCloud API
Mendapatkan kunci API
- Login ke portal SpyCloud sebagai administrator.
- Buka Setelan > API.
- Salin dan simpan kunci API di lokasi yang aman.
Verifikasi izin
Untuk memverifikasi bahwa kunci API Anda memiliki akses yang diperlukan:
- Login ke portal SpyCloud.
- Buka Setelan > API.
- Verifikasi bahwa kunci API aktif dan memiliki akses ke endpoint yang diperlukan (data pelanggaran, daftar pantauan, kompas).
- Jika akses dibatasi, hubungi administrator SpyCloud Anda.
Menguji akses API
Uji kredensial Anda sebelum melanjutkan integrasi:
# Replace with your actual API key API_KEY="your-api-key" # Test API access - fetch watchlist data curl -v -H "X-API-Key: ${API_KEY}" \ "https://api.spycloud.io/enterprise-v2/breach/data/watchlist?since=2024-01-01&until=2024-01-02"
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
spycloud-collector-sa. - Deskripsi akun layanan: Masukkan
Service account for Cloud Run function to collect SpyCloud logs.
- Nama akun layanan: Masukkan
- Klik Create and Continue.
- Di bagian Berikan akun layanan ini akses ke 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 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 (misalnya,
spycloud-logs). - Buka tab Izin.
- Klik Grant access.
- Berikan detail konfigurasi berikut:
- Tambahkan prinsipal: Masukkan email akun layanan (misalnya,
spycloud-collector-sa@your-project.iam.gserviceaccount.com). - Tetapkan peran: Pilih Storage Object Admin.
- Tambahkan prinsipal: Masukkan email akun layanan (misalnya,
- Klik Simpan.
Membuat topik Pub/Sub
Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan akan dilanggan oleh fungsi Cloud Run.
- Di Konsol GCP, buka Pub/Sub > Topics.
- Klik Create topic.
- Berikan detail konfigurasi berikut:
- ID Topik: Masukkan
spycloud-trigger. - Biarkan setelan lainnya tetap 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 SpyCloud API dan menuliskannya ke GCS.
- Di Konsol GCP, 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 spycloud-collectorRegion Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)Runtime Pilih Python 3.12 atau yang lebih baru Di bagian Pemicu (opsional):
- Klik + Tambahkan pemicu.
- Pilih Cloud Pub/Sub.
- Di Select a Cloud Pub/Sub topic, pilih topik
spycloud-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 Security:
- Akun layanan: Pilih akun layanan
spycloud-collector-sa.
- Akun layanan: Pilih akun layanan
Buka tab Containers:
- Klik Variables & Secrets.
- Klik + Tambahkan variabel untuk setiap variabel lingkungan:
Nama Variabel Nilai Contoh Deskripsi GCS_BUCKETspycloud-logsNama bucket GCS GCS_PREFIXspycloudAwalan untuk file log STATE_KEYspycloud/state.jsonJalur file status API_KEYyour-api-keyKunci API SpyCloud API_BASEhttps://api.spycloud.ioURL dasar API MAX_RECORDS10000Jumlah maksimum data per proses LOOKBACK_DAYS7Periode lihat balik awal dalam hari STREAMSwatchlist,catalogAliran data yang dipisahkan koma Scroll ke bawah di tab Variables & Secrets ke Requests:
- Waktu tunggu permintaan: Masukkan
600detik (10 menit).
- Waktu tunggu permintaan: Masukkan
Buka tab Setelan di Kontainer:
- Di bagian Materi:
- Memori: Pilih 512 MiB atau yang lebih tinggi.
- CPU: Pilih 1.
- Di bagian Materi:
Di bagian Penskalaan revisi:
- Minimum number of instances: Masukkan
0. - Jumlah maksimum instance: Masukkan
100(atau sesuaikan berdasarkan perkiraan beban).
- 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 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, 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', 'spycloud') STATE_KEY = os.environ.get('STATE_KEY', 'spycloud/state.json') API_KEY = os.environ.get('API_KEY', '') API_BASE = os.environ.get('API_BASE', 'https://api.spycloud.io').rstrip('/') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000')) LOOKBACK_DAYS = int(os.environ.get('LOOKBACK_DAYS', '7')) STREAMS = [s.strip() for s in os.environ.get('STREAMS', 'watchlist').split(',') if s.strip()] 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 SpyCloud logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, API_KEY]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) now = datetime.now(timezone.utc) # Determine date range if isinstance(state, dict) and state.get("last_date"): since_date = state["last_date"] else: since_date = (now - timedelta(days=LOOKBACK_DAYS)).strftime('%Y-%m-%d') until_date = now.strftime('%Y-%m-%d') print(f"Fetching data from {since_date} to {until_date}") report = {} if 'watchlist' in STREAMS: print("Fetching watchlist breach data...") count = pull_watchlist(bucket, since_date, until_date) report['watchlist_records'] = count if 'catalog' in STREAMS: print("Fetching breach catalog...") count = pull_catalog(bucket, since_date, until_date) report['catalog_records'] = count if 'compass' in STREAMS: print("Fetching compass data...") count = pull_compass(bucket, since_date, until_date) report['compass_records'] = count # Update state save_state(bucket, STATE_KEY, until_date) print(f"Successfully processed: {json.dumps(report)}") 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_date: str): """Save the last query date to GCS state file.""" try: state = {'last_date': last_date, 'last_event_time': datetime.now(timezone.utc).isoformat()} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_date={last_date}") except Exception as e: print(f"Warning: Could not save state: {e}") def api_get(endpoint: str, params: dict = None): """Make authenticated GET request to SpyCloud API with rate limiting.""" url = f"{API_BASE}{endpoint}" if params: query = '&'.join([f"{k}={v}" for k, v in params.items()]) url = f"{url}?{query}" headers = { 'X-API-Key': API_KEY, 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-SpyCloudCollector/1.0' } backoff = 1.0 max_retries = 3 for attempt in range(max_retries): 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 if response.status != 200: print(f"HTTP Error: {response.status} - {response.data.decode('utf-8')}") return None return json.loads(response.data.decode('utf-8')) print(f"Failed after {max_retries} retries due to rate limiting") return None def write_ndjson(bucket, prefix: str, stream_name: str, records: list): """Write records to GCS as NDJSON.""" if not records: return 0 now = datetime.now(timezone.utc) timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/{stream_name}/logs_{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}") return len(records) def pull_watchlist(bucket, since_date: str, until_date: str): """Fetch watchlist breach data.""" cursor = None all_records = [] while True: params = {'since': since_date, 'until': until_date} if cursor: params['cursor'] = cursor data = api_get('/enterprise-v2/breach/data/watchlist', params) if not data: break results = data.get('results', []) if not results: break all_records.extend(results) if len(all_records) >= MAX_RECORDS: print(f"Reached max_records limit ({MAX_RECORDS})") break cursor = data.get('cursor') if not cursor: break return write_ndjson(bucket, GCS_PREFIX, 'watchlist', all_records) def pull_catalog(bucket, since_date: str, until_date: str): """Fetch breach catalog.""" params = {'since': since_date, 'until': until_date} data = api_get('/enterprise-v2/breach/catalog', params) if not data: return 0 results = data.get('results', []) return write_ndjson(bucket, GCS_PREFIX, 'catalog', results) def pull_compass(bucket, since_date: str, until_date: str): """Fetch compass findings.""" cursor = None all_records = [] while True: params = {'since': since_date, 'until': until_date} if cursor: params['cursor'] = cursor data = api_get('/enterprise-v2/compass/data', params) if not data: break results = data.get('results', []) if not results: break all_records.extend(results) if len(all_records) >= MAX_RECORDS: print(f"Reached max_records limit ({MAX_RECORDS})") break cursor = data.get('cursor') if not cursor: break return write_ndjson(bucket, GCS_PREFIX, 'compass', all_records)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).
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 spycloud-collector-dailyRegion Pilih region yang sama dengan fungsi Cloud Run Frekuensi 0 0 * * *(harian pada tengah malam)Zona Waktu Pilih zona waktu (UTC direkomendasikan) Jenis target Pub/Sub Topik Pilih topik spycloud-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 |
| Setiap 6 jam | 0 */6 * * * |
Volume rendah, pemrosesan batch |
| Harian | 0 0 * * * |
Pengumpulan data historis (direkomendasikan untuk data pelanggaran) |
Menguji integrasi
- Di konsol Cloud Scheduler, temukan tugas Anda (
spycloud-collector-daily). - Klik Jalankan paksa untuk memicu secara manual.
- Tunggu beberapa detik, lalu buka Cloud Run > Services > spycloud-collector > Logs.
Pastikan fungsi berhasil dieksekusi. Cari:
Fetching data from YYYY-MM-DD to YYYY-MM-DD Fetching watchlist breach data... Wrote X records to gs://spycloud-logs/spycloud/watchlist/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed: {"watchlist_records": X, "catalog_records": Y}Periksa bucket GCS (
spycloud-logs) untuk mengonfirmasi bahwa log telah ditulis.
Jika Anda melihat error dalam log:
- HTTP 401: Periksa kunci API di variabel lingkungan
- HTTP 403: Pastikan kunci API memiliki akses ke endpoint yang diperlukan
- HTTP 429: Pembatasan kecepatan - fungsi akan otomatis mencoba lagi dengan penundaan
- Variabel lingkungan tidak ada: Pastikan semua variabel yang diperlukan telah ditetapkan
Mengonfigurasi feed di Google SecOps untuk menyerap log SpyCloud
- Buka Setelan SIEM > Feed.
- Klik Tambahkan Feed Baru.
- Klik Konfigurasi satu feed.
- Di kolom Nama feed, masukkan nama untuk feed (misalnya,
SpyCloud Logs). - Pilih Google Cloud Storage V2 sebagai Source type.
- Pilih SpyCloud sebagai Jenis log.
Klik Get Service Account. Email akun layanan yang unik akan ditampilkan, misalnya:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comSalin alamat email ini. Anda akan menggunakannya pada langkah berikutnya.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
URL bucket penyimpanan: Masukkan URI bucket GCS dengan jalur awalan:
gs://spycloud-logs/spycloud/- Ganti:
spycloud-logs: Nama bucket GCS Anda.spycloud: Awalan/jalur folder opsional tempat log disimpan (biarkan kosong untuk root).
- Ganti:
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.
Usia File Maksimum: Sertakan file yang dimodifikasi 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.
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 (
spycloud-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.
Tabel pemetaan UDM
| Kolom Log | Pemetaan UDM | Logika |
|---|---|---|
| av_softwares, assets.av_softwares, assets.country, assets.country_code, assets.display_resolution, assets.email, assets.full_name, assets.infected_machine_id, assets.infected_path, assets.infected_time, assets.ip_addresses, assets.keyboard_languages, assets.password, assets.target_url, assets.username, assets.user_browser, assets.user_hostname, assets.user_os, assets.user_sys_registered_owner | additional.fields | Digabungkan dari label yang dibuat dari kolom ini dan av_software_list |
| sandi | extensions.auth.auth_details | Nilai disalin secara langsung |
| kapan | metadata.event_timestamp | Diuraikan sebagai stempel waktu ISO8601 |
| metadata.event_type | Ditetapkan berdasarkan kondisi: NETWORK_CONNECTION jika has_principal, has_target, has_network; USER_UNCATEGORIZED jika has_principal dan has_principal_userid; STATUS_UPDATE jika has_principal dan bukan has_principal_ip; atau GENERIC_EVENT; atau USER_UNCATEGORIZED jika user_hostname, ip, atau infected_machine_id ada | |
| infected_time | metadata.ingested_timestamp | Diuraikan sebagai stempel waktu dengan format yyyy-MM-ddTHH:mm:ssZ, RFC 3339, ISO8601 |
| log_id, assets.log_id, uuid | metadata.product_log_id | Nilai dari log_id jika tidak kosong, jika tidak, assets.log_id, jika tidak, uuid |
| user_os | network.http.parsed_user_agent | Dikonversi menjadi agen pengguna yang diuraikan |
| user_os | network.http.user_agent | Nilai disalin secara langsung |
| cookie_domain | principal.administrative_domain | Nilai disalin secara langsung |
| country | principal.asset.location.country_or_region | Nilai disalin secara langsung |
| infected_machine_id | principal.asset_id | Digabungkan sebagai "id: " + infected_machine_id |
| infected_path | principal.file.full_path | Nilai disalin secara langsung |
| user_hostname, domain | principal.hostname | Disetel ke user_hostname jika tidak kosong, lalu ke domain jika tidak kosong |
| ip, ip_addresses | principal.ip | Digabungkan dari array ip dan ip_addresses |
| country_code | principal.resource.attribute.labels | Digabungkan dari country_code_label yang dibuat dari country_code |
| id | principal.resource.id | Nilai disalin secara langsung (dikonversi menjadi string) |
| beranda | principal.url | Nilai disalin secara langsung |
| principal.user.email_addresses | Nilai disalin secara langsung | |
| full_name | principal.user.user_display_name | Nilai disalin secara langsung |
| user_sys_registered_owner, email_username | principal.user.userid | Disetel ke user_sys_registered_owner, lalu ke email_username jika tidak kosong |
| keyakinan | security_result.confidence_details | Dikonversi ke string |
| deskripsi | security_result.description | Nilai disalin secara langsung |
| cookie_expiration, cookie_name, cookie_subdomain, cookie_value, day, document_id, locality_zone, source_id, spycloud_publishdate, spycloud_publish_date, user_browser, infected_time, timezone, password_type, password_plaintext, email_domain, api_token, account_status, breach_category, breach_main_category, consumer_category, malware_family, num_records, premium_flag, sensitive_source, short_title, site_description, title, tlp, type, display_resolution, keyboard_languages | security_result.detection_fields | Digabungkan dari label yang dibuat dari kolom ini |
| tingkat keseriusan, | security_result.severity | Disetel ke RENDAH jika "2", INFORMASI jika "5", TINGGI jika "20", KRITIS jika "25" atau "26" |
| tingkat keseriusan, | security_result.severity_details | Nilai disalin secara langsung |
| target_subdomain | target.administrative_domain | Nilai disalin secara langsung |
| target_domain | target.asset.hostname | Nilai disalin secara langsung |
| target_domain | target.hostname | Nilai disalin secara langsung |
| target_url | target.url | Nilai disalin secara langsung |
| nama pengguna | target.user.userid | Nilai disalin secara langsung |
| metadata.product_name | Ditetapkan ke "SPYCLOUD" | |
| metadata.vendor_name | Ditetapkan ke "SpyCloud" | |
spycloud_publish_date", "infected_time", and "timezone |
security_result.detection_fields |
Dipetakan dari log perubahan |
Log Perubahan
Melihat Log Perubahan untuk parser ini
Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.