Mengumpulkan log Team Cymru Scout Threat Intelligence

Didukung di:

Google SecOps SIEM

Dokumen ini menjelaskan cara menyerap data Team Cymru Scout Threat Intelligence ke Google Security Operations menggunakan Google Cloud Storage. Team Cymru Scout menyediakan data intelijen ancaman, termasuk metrik penggunaan akun, batas kueri, dan statistik kueri dasar untuk membantu organisasi memantau postur keamanan dan konsumsi intelijen ancaman mereka.

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 Team Cymru Scout

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, `team-cymru-scout-ti`)
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.

Kumpulkan kredensial Team Cymru Scout API

Login ke Team Cymru Scout Platform.
Buka halaman Kunci API.
Klik tombol Buat.
Berikan deskripsi untuk kunci, jika diperlukan.
Klik tombol Create Key untuk membuat kunci API.
Salin dan simpan detail berikut di lokasi yang aman:
- SCOUT_API_TOKEN: Token akses API
- SCOUT_BASE_URL: URL dasar Scout API (biasanya https://scout.cymru.com)
Catatan: Token API akan digunakan oleh fungsi Cloud Run untuk melakukan autentikasi ke Team Cymru Scout API menggunakan format header Authorization: Token <api_token>. Team Cymru Scout juga mendukung autentikasi Dasar dengan nama pengguna/sandi sebagai alternatif untuk autentikasi Token, tetapi integrasi ini menggunakan autentikasi token.

Menguji akses API

Uji kredensial Anda sebelum melanjutkan integrasi:

# Replace with your actual credentials
SCOUT_API_TOKEN="your-api-token"
SCOUT_BASE_URL="https://scout.cymru.com"

# Test API access to usage endpoint
curl -v --request GET \
  --url "${SCOUT_BASE_URL}/api/scout/usage" \
  --header "Authorization: Token ${SCOUT_API_TOKEN}"

Buat akun layanan untuk Cloud Run Function

Fungsi Cloud Run memerlukan akun layanan dengan izin untuk menulis ke bucket GCS.

Membuat akun layanan

Di GCP Console, buka IAM & Admin > Service Accounts.
Klik Create Service Account.
Berikan detail konfigurasi berikut:
- Nama akun layanan: Masukkan team-cymru-scout-ti-sa.
- Deskripsi akun layanan: Masukkan Service account for Cloud Run function to collect Team Cymru Scout Threat Intelligence data.
Klik Create and Continue.
Di bagian Berikan akun layanan ini akses ke project:
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, team-cymru-scout-ti-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 team-cymru-scout-ti-trigger.
- Biarkan setelan lainnya tetap default.
Klik Buat.

Membuat fungsi Cloud Run untuk mengumpulkan data intelijen ancaman

Fungsi Cloud Run dipicu oleh pesan Pub/Sub dari Cloud Scheduler untuk mengambil data intelijen ancaman dari Team Cymru Scout 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 team-cymru-scout-ti-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 team-cymru-scout-ti-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 team-cymru-scout-ti-sa.

Setelan	Nilai
Nama layanan	`team-cymru-scout-ti-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
`GCS_BUCKET`	`team-cymru-scout-ti`
`GCS_PREFIX`	`team-cymru/scout-ti/`
`STATE_KEY`	`team-cymru/scout-ti/state.json`
`SCOUT_BASE_URL`	`https://scout.cymru.com`
`SCOUT_API_TOKEN`	`your-scout-api-token`
`COLLECTION_INTERVAL_HOURS`	`1`
`HTTP_TIMEOUT`	`60`
`HTTP_RETRIES`	`3`

Scroll ke bawah di tab Variables & Secrets ke Requests:
- Waktu tunggu permintaan: Masukkan 600 detik (10 menit).
Buka tab Setelan di Penampung:
- Di bagian Materi:
  - Memori: Pilih 512 MiB atau yang lebih tinggi.
  - CPU: Pilih 1.
- Klik Selesai.
Scroll ke bawah ke Lingkungan eksekusi:
- Pilih Default (direkomendasikan).
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
http = urllib3.PoolManager()

# Initialize Storage client
storage_client = storage.Client()

@functions_framework.cloud_event
def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch usage data from Team Cymru Scout 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', 'team-cymru/scout-ti/')
    state_key = os.environ.get('STATE_KEY', 'team-cymru/scout-ti/state.json')
    collection_interval_hours = int(os.environ.get('COLLECTION_INTERVAL_HOURS', '1'))
    http_timeout = int(os.environ.get('HTTP_TIMEOUT', '60'))
    http_retries = int(os.environ.get('HTTP_RETRIES', '3'))

    # Team Cymru Scout API credentials
    scout_base_url = os.environ.get('SCOUT_BASE_URL', 'https://scout.cymru.com')
    scout_api_token = os.environ.get('SCOUT_API_TOKEN')

    if not all([bucket_name, scout_api_token]):
        print('Error: Missing required environment variables')
        return

    try:
        # Get GCS bucket
        bucket = storage_client.bucket(bucket_name)

        # Load state (last collection timestamp)
        state = load_state(bucket, state_key)
        now = time.time()
        last_collection = state.get('last_collection_ts', now - (collection_interval_hours * 3600))

        print(f'Collecting usage data at {iso_format(now)} (last collection: {iso_format(last_collection)})')

        # Fetch usage data from Team Cymru Scout API
        usage_data = fetch_usage_data(
            scout_base_url, 
            scout_api_token, 
            http_timeout,
            http_retries
        )

        if usage_data:
            # Add timestamp and event type
            usage_data['event_type'] = 'account_usage'
            usage_data['collection_timestamp'] = iso_format(now)

            # Write to GCS
            write_to_gcs(bucket, prefix, usage_data, now)

            # Update state
            save_state(bucket, state_key, {'last_collection_ts': now})

            print(f'Successfully collected and stored usage data')
        else:
            print('No usage data retrieved')

    except Exception as e:
        print(f'Error processing usage data: {str(e)}')
        raise

def iso_format(ts):
    """Convert Unix timestamp to ISO 8601 format."""
    return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(ts))

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 {}

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 http_request(url, method='GET', body=None, headers=None, timeout=60, retries=3):
    """Make HTTP request with retry logic."""
    attempt = 0
    while True:
        try:
            req_headers = headers or {}
            if body is not None:
                req_headers['Content-Type'] = 'application/json'
                body_bytes = body.encode('utf-8') if isinstance(body, str) else body
            else:
                body_bytes = None

            response = http.request(
                method,
                url,
                body=body_bytes,
                headers=req_headers,
                timeout=timeout
            )

            if response.status == 200:
                return response.data, response.headers.get('Content-Type', 'application/json')
            elif response.status in (429, 500, 502, 503, 504) and attempt < retries:
                delay = 1 + attempt
                retry_after = response.headers.get('Retry-After')
                if retry_after:
                    try:
                        delay = int(retry_after)
                    except:
                        pass
                time.sleep(max(1, delay))
                attempt += 1
                continue
            else:
                raise Exception(f'HTTP {response.status}: {response.data.decode("utf-8")}')
        except urllib3.exceptions.HTTPError as e:
            if attempt < retries:
                time.sleep(1 + attempt)
                attempt += 1
                continue
            raise

def fetch_usage_data(base_url, api_token, timeout, retries):
    """
    Fetch usage data from Team Cymru Scout API.

    Implementation mirrors the official Scout API example:
    curl --request GET --url 'https://scout.cymru.com/api/scout/usage' --header 'Authorization: Token valid_api_token'
    """
    # Use the documented /api/scout/usage endpoint
    url = f'{base_url}/api/scout/usage'

    # Use Token authentication as documented
    headers = {
        'Authorization': f'Token {api_token}',
        'Accept': 'application/json'
    }

    print(f'Fetching usage data from {url}')

    try:
        # Fetch data
        blob_data, content_type = http_request(url, method='GET', headers=headers, timeout=timeout, retries=retries)

        # Parse response
        usage_data = json.loads(blob_data.decode('utf-8'))

        print(f'Retrieved usage data: used_queries={usage_data.get("used_queries")}, query_limit={usage_data.get("query_limit")}')

        return usage_data

    except Exception as e:
        print(f'Error fetching usage data: {e}')
        return None

def write_to_gcs(bucket, prefix, data, timestamp):
    """Write data to GCS."""
    # Create date-based path
    date_path = time.strftime('%Y/%m/%d', time.gmtime(timestamp))
    key = f'{prefix}{date_path}/usage_{int(timestamp)}.json'

    # Write as JSON
    blob = bucket.blob(key)
    blob.upload_from_string(
        json.dumps(data, separators=(',', ':')),
        content_type='application/json'
    )
    print(f'Wrote data to gs://{bucket.name}/{key}')

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. Implementasi ini menggunakan endpoint Team Cymru Scout API /api/scout/usage yang didokumentasikan dengan autentikasi Authorization: Token <api_token> seperti yang ditentukan dalam dokumentasi Scout API resmi.

Buat tugas Cloud Scheduler

Cloud Scheduler 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	`team-cymru-scout-ti-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 `team-cymru-scout-ti-trigger`
Isi pesan	`{}` (objek JSON kosong)

Klik Buat.

Opsi frekuensi jadwal

Pilih frekuensi berdasarkan volume data dan persyaratan latensi:

Frekuensi	Ekspresi Cron	Kasus Penggunaan
Setiap 5 menit	`/5 * * *`	Pemantauan frekuensi tinggi
Setiap 15 menit	`/15 * * *`	Frekuensi sedang
Setiap jam	`0 * * * *`	Standar (direkomendasikan)
Setiap 6 jam	`0 /6 * *`	Frekuensi rendah
Harian	`0 0 * * *`	Pelacakan penggunaan harian

Menguji tugas penjadwal

Di konsol Cloud Scheduler, temukan tugas Anda.
Klik Jalankan paksa untuk memicu secara manual.
Tunggu beberapa detik, lalu buka Cloud Run > Services > team-cymru-scout-ti-collector > Logs.
Pastikan fungsi berhasil dieksekusi.
Periksa bucket GCS untuk mengonfirmasi bahwa data penggunaan telah ditulis.

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, Team Cymru Scout Threat Intelligence).
Pilih Google Cloud Storage V2 sebagai Source type.
Pilih Team Cymru Scout Threat Intelligence 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.
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 data Team Cymru Scout Threat Intelligence

Buka Setelan SIEM > Feed.
Klik Tambahkan Feed Baru.
Klik Konfigurasi satu feed.
Di kolom Nama feed, masukkan nama untuk feed (misalnya, Team Cymru Scout Threat Intelligence).
Pilih Google Cloud Storage V2 sebagai Source type.
Pilih Team Cymru Scout Threat Intelligence sebagai Jenis log.
Klik Berikutnya.
Tentukan nilai untuk parameter input berikut:
- URL bucket penyimpanan: Masukkan URI bucket GCS dengan jalur awalan:
```
gs://team-cymru-scout-ti/team-cymru/scout-ti/
```
  - Ganti:
    - team-cymru-scout-ti: Nama bucket GCS Anda.
    - team-cymru/scout-ti/: Jalur folder/awalan 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.