Mengumpulkan log PhishLabs

Didukung di:

Dokumen ini menjelaskan cara menyerap log PhishLabs ke Google Security Operations menggunakan Google Cloud Storage V2.

PhishLabs (sekarang Fortra Brand Protection) adalah platform perlindungan risiko digital untuk mendeteksi dan memitigasi phishing, penyalahgunaan merek, dan ancaman media sosial. Layanan ini menyediakan data insiden dan indikator penyusupan (IOC) melalui Incident Data API dan IOC API. Parser mengekstrak kolom dari data peristiwa PhishLabs dan memetakannya ke Model Data Terpadu (UDM), yang menangkap metadata email, klasifikasi keamanan, dan detail threat intelligence.

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 istimewa ke PhishLabs dengan token API yang valid untuk Incident Data API dan IOC API

Membuat bucket Google Cloud Storage

  1. Buka Konsol Google Cloud.
  2. Pilih project Anda atau buat project baru.
  3. Di menu navigasi, buka Cloud Storage > Buckets.
  4. Klik Create bucket.
  5. Berikan detail konfigurasi berikut:

    Setelan Nilai
    Memberi nama bucket Anda Masukkan nama yang unik secara global (misalnya, phishlabs-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
  6. Klik Create.

Mengumpulkan kredensial PhishLabs API

Mendapatkan token API

  1. Login ke portal PhishLabs.
  2. Buka setelan akun Anda atau hubungi perwakilan akun PhishLabs (Fortra) Anda untuk mendapatkan token API.
  3. Salin dan simpan token API (Token pemilik) dengan aman.

Memverifikasi izin

Untuk memverifikasi bahwa token API memiliki izin yang diperlukan:

  1. Login ke portal PhishLabs.
  2. Buka setelan akun Anda.
  3. Pastikan token API aktif dan memiliki akses ke Incident Data API.
  4. Jika Anda tidak dapat mengakses setelan API, hubungi perwakilan akun PhishLabs Anda.

Menguji akses API

  • Uji kredensial Anda sebelum melanjutkan integrasi:

    # Replace with your actual credentials
    API_TOKEN="<your-api-token>"
    
    # Test Incident Data API access
    curl -v -H "Authorization: Bearer ${API_TOKEN}" \
      "https://caseapi.phishlabs.com/idapi/v1/incidents?limit=5&offset=0"
    

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

  1. Di Konsol GCP, buka IAM & Admin > Service Accounts.
  2. Klik Create Service Account.
  3. Berikan detail konfigurasi berikut:
    • Service account name: Masukkan phishlabs-collector-sa
    • Service account description: Masukkan Service account for Cloud Run function to collect PhishLabs logs
  4. Klik Create and Continue.
  5. Di bagian Grant this service account access to 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.
  6. Klik Lanjutkan.
  7. 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:

  1. Buka Cloud Storage > Buckets.
  2. Klik nama bucket Anda (misalnya, phishlabs-logs).
  3. Buka tab Izin.
  4. Klik Grant access.
  5. Berikan detail konfigurasi berikut:
    • Tambahkan entitas: Masukkan email akun layanan (misalnya, phishlabs-collector-sa@PROJECT_ID.iam.gserviceaccount.com)
    • Assign roles: Pilih Storage Object Admin
  6. Klik Simpan.

Membuat topik Pub/Sub

Buat topik Pub/Sub yang akan dipublikasikan oleh Cloud Scheduler dan di-subscribe oleh fungsi Cloud Run.

  1. Di Konsol GCP, buka Pub/Sub > Topics.
  2. Klik Create topic.
  3. Berikan detail konfigurasi berikut:
    • ID Topik: Masukkan phishlabs-logs-trigger
    • Biarkan setelan lainnya sesuai default
  4. Klik Create.

Membuat fungsi Cloud Run untuk mengumpulkan log

Fungsi Cloud Run akan dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil data insiden dan IOC dari API PhishLabs dan menulisnya ke GCS.

  1. Di Konsol GCP, buka Cloud Run.
  2. Klik Create service.
  3. Pilih Function (gunakan editor inline untuk membuat fungsi).
  4. Di bagian Configure, berikan detail konfigurasi berikut:

    Setelan Nilai
    Nama layanan phishlabs-collector
    Region Pilih region yang cocok dengan bucket GCS Anda (misalnya, us-central1)
    Runtime Pilih Python 3.12 atau yang lebih baru
  5. Di bagian Trigger (optional):

    1. Klik + Tambahkan pemicu.
    2. Pilih Cloud Pub/Sub.
    3. Di Select a Cloud Pub/Sub topic, pilih topik Pub/Sub (phishlabs-logs-trigger).
    4. Klik Simpan.
  6. Di bagian Authentication:

    1. Pilih Wajibkan autentikasi.
    2. Periksa Identity and Access Management (IAM).
  7. Scroll ke bawah dan luaskan Containers, Networking, Security.

  8. Buka tab Keamanan:

    • Service account: Pilih akun layanan (phishlabs-collector-sa)
  9. Buka tab Penampung:

    1. Klik Variables & Secrets.
    2. Klik + Add variable untuk setiap variabel lingkungan:
    Nama Variabel Nilai Contoh Deskripsi
    GCS_BUCKET phishlabs-logs Nama bucket GCS
    GCS_PREFIX phishlabs Awalan untuk file log
    STATE_KEY phishlabs/state.json Jalur file status
    API_TOKEN your-bearer-token Token pemilik API PhishLabs
    COLLECT_IOCS true Kumpulkan juga data IOC (benar/salah)
    MAX_RECORDS 1000 Data maksimum per operasi
    PAGE_SIZE 50 Data per halaman
    LOOKBACK_HOURS 24 Periode lihat balik awal
  10. Di bagian Variables & Secrets, scroll ke bawah ke Requests:

    • Request timeout: Masukkan 600 detik (10 menit)
  11. Buka tab Setelan:

    • Di bagian Resources:
      • Memory: Pilih 512 MiB atau lebih tinggi
      • CPU: Pilih 1
  12. Di bagian Revision scaling:

    • Minimum number of instances: Masukkan 0
    • Maximum number of instances: Masukkan 100 (atau sesuaikan berdasarkan beban yang diharapkan)
  13. Klik Create.

  14. Tunggu hingga layanan dibuat (1-2 menit).

  15. Setelah layanan dibuat, editor kode inline akan terbuka secara otomatis.

Menambahkan kode fungsi

  1. Masukkan main di kolom Entry point.
  2. Di editor kode inline, buat dua file:

    • 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', 'phishlabs')
    STATE_KEY = os.environ.get('STATE_KEY', 'phishlabs/state.json')
    API_TOKEN = os.environ.get('API_TOKEN')
    COLLECT_IOCS = os.environ.get('COLLECT_IOCS', 'true').lower() == 'true'
    MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '1000'))
    PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '50'))
    LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24'))
    
    INCIDENT_API_BASE = "https://caseapi.phishlabs.com/idapi/v1"
    IOC_API_BASE = "https://ioc.phishlabs.com/api/v1"
    
    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 PhishLabs
      incident and IOC data and write to GCS.
    
      Args:
        cloud_event: CloudEvent object containing Pub/Sub message
      """
    
      if not all([GCS_BUCKET, API_TOKEN]):
        print('Error: Missing required environment variables')
        return
    
      try:
        # Get GCS bucket
        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"])
            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()}")
    
        all_records = []
    
        # Fetch incidents from Incident Data API
        incidents, newest_incident_time = fetch_incidents(
          token=API_TOKEN,
          page_size=PAGE_SIZE,
          max_records=MAX_RECORDS,
        )
        if incidents:
          all_records.extend(incidents)
          print(f"Collected {len(incidents)} incidents")
    
        # Fetch IOCs if enabled
        if COLLECT_IOCS:
          lookback_seconds = int((now - last_time).total_seconds())
          iocs, newest_ioc_time = fetch_iocs(
            token=API_TOKEN,
            since_seconds=lookback_seconds,
          )
          if iocs:
            all_records.extend(iocs)
            print(f"Collected {len(iocs)} IOCs")
    
        if not all_records:
          print("No new 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
        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_incidents(token: str, page_size: int, max_records: int):
      """
      Fetch incidents from the PhishLabs Incident Data API with pagination.
    
      Args:
        token: Bearer token for authentication
        page_size: Number of records per page
        max_records: Maximum total records to fetch
    
      Returns:
        Tuple of (records list, newest_event_time ISO string)
      """
      headers = {
        'Authorization': f'Bearer {token}',
        'Accept': 'application/json',
        'User-Agent': 'GoogleSecOps-PhishLabsCollector/1.0',
      }
    
      records = []
      newest_time = None
      page_num = 0
      backoff = 1.0
      offset = 0
    
      while True:
        page_num += 1
    
        if len(records) >= max_records:
          print(f"Reached max_records limit ({max_records})")
          break
    
        current_limit = min(page_size, max_records - len(records))
        url = f"{INCIDENT_API_BASE}/incidents?limit={current_limit}&offset={offset}"
    
        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'))
    
          if isinstance(data, list):
            page_results = data
          else:
            page_results = data.get('incidents', data.get('results', []))
    
          if not page_results:
            print(f"No more incident results (empty page)")
            break
    
          print(f"Incidents page {page_num}: Retrieved {len(page_results)} events")
          records.extend(page_results)
    
          # Track newest event time
          for event in page_results:
            try:
              event_time = event.get('createdAt') or event.get('dateCreated')
              if event_time:
                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}")
    
          if len(page_results) < current_limit:
            print(f"Reached last page (size={len(page_results)} < limit={current_limit})")
            break
    
          offset += len(page_results)
    
        except Exception as e:
          print(f"Error fetching incidents: {e}")
          return [], None
    
      print(f"Retrieved {len(records)} total incidents from {page_num} pages")
      return records, newest_time
    
    def fetch_iocs(token: str, since_seconds: int):
      """
      Fetch IOCs from the PhishLabs IOC API.
    
      Args:
        token: Bearer token for authentication
        since_seconds: Fetch IOCs from the last N seconds
    
      Returns:
        Tuple of (records list, newest_event_time ISO string)
      """
      headers = {
        'Authorization': f'Bearer {token}',
        'Accept': 'application/json',
        'User-Agent': 'GoogleSecOps-PhishLabsCollector/1.0',
      }
    
      # Convert seconds to a relative time string
      since_hours = max(1, since_seconds // 3600)
      url = f"{IOC_API_BASE}/iocs?since={since_hours}h"
    
      try:
        response = http.request('GET', url, headers=headers)
    
        if response.status != 200:
          print(f"IOC API HTTP Error: {response.status}")
          return [], None
    
        data = json.loads(response.data.decode('utf-8'))
    
        if isinstance(data, list):
          iocs = data
        else:
          iocs = data.get('iocs', data.get('results', []))
    
        print(f"Retrieved {len(iocs)} IOCs")
        return iocs, None
    
      except Exception as e:
        print(f"Error fetching IOCs: {e}")
        return [], None
    
    • requirements.txt:
    functions-framework==3.*
    google-cloud-storage==2.*
    urllib3>=2.0.0
    
  3. Klik Deploy untuk menyimpan dan men-deploy fungsi.

  4. 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.

  1. Di Konsol GCP, buka Cloud Scheduler.
  2. Klik Create Job.
  3. Berikan detail konfigurasi berikut:

    Setelan Nilai
    Nama phishlabs-collector-hourly
    Region 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 Pub/Sub (phishlabs-logs-trigger)
    Isi pesan {} (objek JSON kosong)
  4. 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

  1. Di konsol Cloud Scheduler, temukan tugas Anda.
  2. Klik Force run untuk memicu tugas secara manual.
  3. Tunggu beberapa detik.
  4. Buka Cloud Run > Services.
  5. Klik nama fungsi Anda (phishlabs-collector).
  6. Klik tab Logs.
  7. Pastikan fungsi berhasil dieksekusi. Cari:

    Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
    Incidents page 1: Retrieved X events
    Collected X incidents
    Retrieved X IOCs
    Wrote X records to gs://phishlabs-logs/phishlabs/logs_YYYYMMDD_HHMMSS.ndjson
    Successfully processed X records
    
  8. Buka Cloud Storage > Buckets.

  9. Klik nama bucket Anda (phishlabs-logs).

  10. Buka folder awalan (phishlabs/).

  11. Pastikan file .ndjson baru telah dibuat dengan stempel waktu saat ini.

Jika Anda melihat error di log:

  • HTTP 401: Periksa token API di variabel lingkungan
  • HTTP 403: Pastikan token API memiliki akses ke Incident Data API dan IOC API
  • HTTP 429: Pembatasan kapasitas - fungsi akan otomatis mencoba lagi dengan backoff
  • Variabel lingkungan tidak ada: Pastikan 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.

Mendapatkan email akun layanan

  1. Buka Setelan > Pengelolaan Data > Feed. Jika Anda menggunakan platform khusus SIEM, buka Settings > Feeds.
  2. Klik Tambahkan Feed Berita Baru.
  3. Klik Konfigurasi satu feed.
  4. Di kolom Nama feed, masukkan nama untuk feed (misalnya, PhishLabs Logs).
  5. Pilih Google Cloud Storage V2 sebagai Source type.
  6. Pilih PhishLabs sebagai Log type.
  7. Klik Get Service Account.
  8. Email akun layanan yang unik akan ditampilkan, misalnya:

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
    
  9. Salin alamat email ini untuk digunakan di langkah berikutnya.

  10. Klik Berikutnya.

  11. Tentukan nilai untuk parameter input berikut:

    • Storage bucket URL: Masukkan URI bucket GCS dengan jalur awalan:

      gs://phishlabs-logs/phishlabs/
      
      • Ganti:
        • phishlabs-logs: Nama bucket GCS Anda.
        • phishlabs: Jalur awalan/folder opsional tempat log disimpan (biarkan kosong untuk root).
    • 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

  12. Klik Berikutnya.

  13. 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.

  1. Buka Cloud Storage > Buckets.
  2. Klik nama bucket Anda (misalnya, phishlabs-logs).
  3. Buka tab Izin.
  4. Klik Grant access.
  5. Berikan detail konfigurasi berikut:
    • Add principals: Tempel email akun layanan Google SecOps
    • Assign roles: Pilih Storage Object Viewer
  6. Klik Simpan.

Tabel pemetaan UDM

Kolom Log Pemetaan UDM Logika
service, closed, status, details.emailReportedBy, details.emailReceivedDate, details.payloadFamily, details.offlineUponReview additional.fields Data peristiwa tambahan khusus vendor yang tidak dapat direpresentasikan secara memadai dalam bagian formal model UDM
deskripsi metadata.description Deskripsi peristiwa
metadata.event_type Jenis peristiwa (misalnya, USER_LOGIN, NETWORK_CONNECTION)
id metadata.product_log_id ID unik untuk entri log dari produk
sender_email network.email.from Alamat email pengirim
details.messageID network.email.mail_id ID unik untuk pesan email
emailData.address network.email.reply_to Alamat email balas-ke
title network.email.subject Baris subjek email
emailData.address network.email.to Alamat email penerima
durasi network.session_duration.seconds Durasi sesi dalam detik
detailUrl.url principal.process.file.embedded_urls URL yang disematkan dalam file yang terkait dengan proses
src_email principal.user.email_addresses Alamat email yang terkait dengan pengguna
user_name principal.user.user_display_name Nama tampilan pengguna
details.classification, details.severity, details.furtherReviewReason, details.subClassification, details.caseType, details.emailBody, details.submissionMethod, detailUrl.url, detailUrl.malicious, detailUrl.maliciousDomain security_result Klasifikasi atau tindakan keamanan yang dilakukan oleh produk keamanan
metadata.product_name Nama produk
metadata.vendor_name Nama vendor
details.urls.url", "details.urls.malicious", and "details.urls.maliciousDomain 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.