收集 Splunk Attack Analyzer 記錄

支援的國家/地區：

本文說明如何使用 Google Cloud Storage V2，將 Splunk Attack Analyzer 記錄檔擷取至 Google Security Operations。

Splunk Attack Analyzer (舊稱 TwinWave) 是一個自動化威脅分析平台，可透過行為分析偵測網路釣魚和惡意軟體。並透過 REST API 提供完成的工作結果和標準化鑑識資料。

事前準備

請確認您已完成下列事前準備事項：

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage API 的 GCP 專案
  • 建立及管理 GCS bucket 的權限
  • 管理 Google Cloud Storage 值區 IAM 政策的權限
  • 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • 具備 API 金鑰產生權限，可存取 Splunk Attack Analyzer 的特殊權限

建立 Google Cloud Storage bucket

  1. 前往 Google Cloud 控制台。
  2. 選取專案或建立新專案。
  3. 在導覽選單中，依序前往「Cloud Storage」>「Bucket」。
  4. 按一下「建立值區」。

  5. 請提供下列設定詳細資料：

    設定 值
    為 bucket 命名 輸入全域不重複的名稱 (例如 splunk-attack-analyzer-logs)
    位置類型 根據需求選擇 (區域、雙區域、多區域)
    位置 選取位置 (例如 us-central1)
    儲存空間級別 標準 (建議用於經常存取的記錄)
    存取控管 統一 (建議)
    保護工具 選用：啟用物件版本管理或資料保留政策

  6. 點選「建立」。

收集 Splunk Attack Analyzer API 憑證

產生 API 金鑰

  1. 登入 Splunk Attack Analyzer。
  2. 選取右上角的使用者名稱，然後選取「API 金鑰」。
  3. 按一下「+ 新增金鑰」。
  4. 輸入金鑰的描述性名稱 (例如 Google Security Operations Integration)。
  5. 點選「建立」。

  6. 複製並儲存模式中顯示的 API 密鑰，並存放在安全位置。

驗證權限

如要確認 API 金鑰是否具備必要存取權，請按照下列步驟操作：

  1. 登入 Splunk Attack Analyzer。
  2. 選取右上角的使用者名稱，然後選取「API 金鑰」。

  3. 確認 API 金鑰已列出並啟用。

測試 API 存取權

  • 請先測試憑證，再繼續進行整合：

    # Replace with your actual API key
API_KEY="your-api-key"

# Test API access - list completed jobs
curl -v -H "Authorization: Bearer ${API_KEY}" \
  "https://app.twinwave.io/api/v1/jobs?done=true&limit=1"

為 Cloud Run 函式建立服務帳戶

Cloud Run 函式需要具備 GCS bucket 寫入權限，且可由 Pub/Sub 叫用的服務帳戶。

建立服務帳戶

  1. 在 GCP 控制台中，依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  2. 按一下「Create Service Account」(建立服務帳戶)。
  3. 請提供下列設定詳細資料：
    • 服務帳戶名稱：輸入 saa-collector-sa。
    • 服務帳戶說明：輸入 Service account for Cloud Run function to collect Splunk Attack Analyzer logs。
  4. 按一下「建立並繼續」。
  5. 在「將專案存取權授予這個服務帳戶」部分，新增下列角色：
    1. 按一下「選擇角色」。
    2. 搜尋並選取「Storage 物件管理員」。
    3. 點選「+ 新增其他角色」。
    4. 搜尋並選取「Cloud Run Invoker」。
    5. 點選「+ 新增其他角色」。
    6. 搜尋並選取「Cloud Functions Invoker」(Cloud Functions 叫用者)。
  6. 按一下「繼續」。
  7. 按一下 [完成]。

這些角色適用於：

  • Storage 物件管理員：將記錄檔寫入 GCS bucket，並管理狀態檔案
  • Cloud Run 叫用者：允許 Pub/Sub 叫用函式
  • Cloud Functions 叫用者：允許函式叫用

授予 GCS 值區的 IAM 權限

將 GCS bucket 的寫入權限授予服務帳戶：

  1. 依序前往「Cloud Storage」>「Buckets」。
  2. 按一下 bucket 名稱 (例如 splunk-attack-analyzer-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：輸入服務帳戶電子郵件地址 (例如 saa-collector-sa@your-project.iam.gserviceaccount.com)。
    • 指派角色：選取「Storage 物件管理員」。
  6. 按一下 [儲存]。

建立 Pub/Sub 主題

建立 Pub/Sub 主題，Cloud Scheduler 會將訊息發布至該主題，而 Cloud Run 函式會訂閱該主題。

  1. 在 GCP Console 中，前往「Pub/Sub」>「Topics」(主題)。
  2. 按一下「建立主題」。
  3. 請提供下列設定詳細資料：
    • 主題 ID：輸入 saa-trigger。
    • 其他設定保留預設值。
  4. 點選「建立」。

建立 Cloud Run 函式來收集記錄

Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發，從 Splunk Attack Analyzer API 擷取記錄，並寫入 GCS。

  1. 前往 GCP Console 的「Cloud Run」。
  2. 按一下「Create service」(建立服務)。
  3. 選取「函式」 (使用內嵌編輯器建立函式)。

  4. 在「設定」部分，提供下列設定詳細資料：

    設定 值
    服務名稱 saa-collector
    區域 選取與 GCS bucket 相符的區域 (例如 us-central1)
    執行階段 選取 Python 3.12 以上版本

  5. 在「Trigger (optional)」(觸發條件 (選用)) 專區：

    1. 按一下「+ 新增觸發條件」。
    2. 選取「Cloud Pub/Sub」。
    3. 在「選取 Cloud Pub/Sub 主題」中，選擇主題 saa-trigger。
    4. 按一下 [儲存]。

  6. 在「Authentication」(驗證) 部分：

    1. 選取「需要驗證」。
    2. 檢查 Identity and Access Management (IAM)。

  7. 向下捲動並展開「容器」、「網路」和「安全性」。

  8. 前往「安全性」分頁：

    • 服務帳戶：選取服務帳戶 saa-collector-sa。

  9. 前往「容器」分頁：

    1. 按一下「變數與密鑰」。
    2. 針對每個環境變數，按一下「+ 新增變數」：
    變數名稱 範例值 說明
    GCS_BUCKET splunk-attack-analyzer-logs GCS bucket 名稱
    GCS_PREFIX saa 記錄檔的前置字串
    STATE_KEY saa/state.json 狀態檔案路徑
    API_KEY your-api-key Splunk Attack Analyzer API 金鑰
    API_BASE https://app.twinwave.io API 基準網址
    MAX_RECORDS 5000 每次執行的記錄數上限
    PAGE_SIZE 100 每頁記錄數
    LOOKBACK_HOURS 24 初始回溯期

  10. 在「變數與密鑰」分頁中向下捲動至「要求」：

    • 要求逾時：輸入 600 秒 (10 分鐘)。

  11. 前往「容器」中的「設定」分頁：

    • 在「資源」部分：
      • 記憶體：選取 512 MiB 以上。
      • CPU：選取 1。

  12. 在「修訂版本資源調度」部分：

    • 執行個體數量下限：輸入 0。
    • 「Maximum number of instances」(執行個體數量上限)：輸入 100 (或根據預期負載調整)。

  13. 點選「建立」。

  14. 等待服務建立完成 (1 到 2 分鐘)。

  15. 服務建立完成後，系統會自動開啟內嵌程式碼編輯器。

新增函式程式碼

  1. 在「函式進入點」中輸入 main。

  2. 在內嵌程式碼編輯器中，建立兩個檔案：

    • 第一個檔案：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', 'saa')
STATE_KEY = os.environ.get('STATE_KEY', 'saa/state.json')
API_KEY = os.environ.get('API_KEY', '')
API_BASE = os.environ.get('API_BASE', 'https://app.twinwave.io').rstrip('/')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100'))
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 Splunk Attack Analyzer 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)

    # 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 jobs from {last_time.isoformat()} to {now.isoformat()}")

    # Fetch completed jobs
    jobs, newest_event_time = fetch_jobs(
      start_time=last_time,
      end_time=now,
      page_size=PAGE_SIZE,
      max_records=MAX_RECORDS,
    )

    if not jobs:
      print("No new completed jobs found.")
      save_state(bucket, STATE_KEY, now.isoformat())
      return

    # Fetch forensics for each job
    all_records = []
    for job in jobs:
      job_id = job.get('id', '')
      if not job_id:
        continue

      forensics = fetch_forensics(job_id)
      if forensics:
        # Combine job metadata with forensics
        record = {
          'job': job,
          'forensics': forensics
        }
        all_records.append(record)

    if not all_records:
      print("No forensics data retrieved.")
      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}")

    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_jobs(start_time: datetime, end_time: datetime, page_size: int, max_records: int):
  """
  Fetch completed jobs from Splunk Attack Analyzer API with pagination and rate limiting.

  Args:
    start_time: Start time for job query
    end_time: End time for job query
    page_size: Number of records per page
    max_records: Maximum total records to fetch

  Returns:
    Tuple of (jobs list, newest_event_time ISO string)
  """
  endpoint = f"{API_BASE}/api/v1/jobs"

  headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Accept': 'application/json',
    'User-Agent': 'GoogleSecOps-SAACollector/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"{endpoint}?done=true&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'))

      page_results = data.get('jobs', [])

      if not page_results:
        print(f"No more results (empty page)")
        break

      # Filter by time window
      filtered = []
      for job in page_results:
        created = job.get('created_at', '')
        if created:
          try:
            job_time = parse_datetime(created)
            if start_time <= job_time <= end_time:
              filtered.append(job)
              if newest_time is None or job_time > parse_datetime(newest_time):
                newest_time = created
          except Exception as e:
            print(f"Warning: Could not parse job time: {e}")
            filtered.append(job)

      print(f"Page {page_num}: Retrieved {len(page_results)} jobs, {len(filtered)} in time window")
      records.extend(filtered)

      if len(page_results) < page_size:
        print(f"Reached last page (size={len(page_results)} < limit={page_size})")
        break

      offset += len(page_results)

    except Exception as e:
      print(f"Error fetching jobs: {e}")
      return [], None

  print(f"Retrieved {len(records)} total jobs from {page_num} pages")
  return records, newest_time

def fetch_forensics(job_id: str):
  """
  Fetch normalized forensics for a specific job.

  Args:
    job_id: The job ID

  Returns:
    Forensics data dict or None
  """
  endpoint = f"{API_BASE}/api/v1/jobs/{job_id}/normalizedforensics"

  headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Accept': 'application/json',
    'User-Agent': 'GoogleSecOps-SAACollector/1.0'
  }

  backoff = 1.0
  max_retries = 3

  for attempt in range(max_retries):
    try:
      response = http.request('GET', endpoint, headers=headers)

      if response.status == 429:
        retry_after = int(response.headers.get('Retry-After', str(int(backoff))))
        print(f"Rate limited (429) on forensics for job {job_id}. Retrying after {retry_after}s...")
        time.sleep(retry_after)
        backoff = min(backoff * 2, 30.0)
        continue

      if response.status != 200:
        print(f"Warning: Could not fetch forensics for job {job_id}: HTTP {response.status}")
        return None

      return json.loads(response.data.decode('utf-8'))

    except Exception as e:
      print(f"Warning: Error fetching forensics for job {job_id}: {e}")
      if attempt < max_retries - 1:
        time.sleep(backoff)
        backoff = min(backoff * 2, 30.0)
        continue
      return None

  return None

    • 第二個檔案：requirements.txt:

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

  3. 點選「部署」即可儲存並部署函式。

  4. 等待部署作業完成 (2 到 3 分鐘)。

建立 Cloud Scheduler 工作

Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題，觸發 Cloud Run 函式。

  1. 前往 GCP 主控台的「Cloud Scheduler」。
  2. 點選「建立工作」。

  3. 請提供下列設定詳細資料：

    設定 值
    名稱 saa-collector-hourly
    區域 選取與 Cloud Run 函式相同的區域
    頻率 0 * * * * (每小時整點)
    時區 選取時區 (建議使用世界標準時間)
    目標類型 Pub/Sub
    主題 選取主題 saa-trigger
    郵件內文 {} (空白 JSON 物件)

  4. 點選「建立」。

排程頻率選項

根據記錄檔量和延遲時間要求選擇頻率：

頻率 Cron 運算式 用途
每 5 分鐘 */5 * * * * 大量低延遲
每 15 分鐘 */15 * * * * 中等
每小時 0 * * * * 標準 (建議)
每 6 小時 0 */6 * * * 少量、批次處理
每日 0 0 * * * 歷來資料集合

測試整合項目

  1. 在 Cloud Scheduler 控制台中，找出您的工作 (saa-collector-hourly)。
  2. 按一下「強制執行」即可手動觸發。
  3. 等待幾秒鐘，然後依序前往「Cloud Run」>「Services」(服務) >「saa-collector」>「Logs」(記錄)。

  4. 確認函式是否已順利執行。尋找：

    Fetching jobs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
Page 1: Retrieved X jobs, Y in time window
Wrote Z records to gs://splunk-attack-analyzer-logs/saa/logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed Z records

  5. 檢查 GCS 值區 (splunk-attack-analyzer-logs)，確認記錄是否已寫入。

如果記錄中顯示錯誤：

  • HTTP 401：檢查環境變數中的 API 金鑰
  • HTTP 403：確認 API 金鑰是否具備必要權限
  • HTTP 429：頻率限制 - 函式會自動重試，並延遲一段時間
  • 缺少環境變數：檢查是否已設定所有必要變數

在 Google SecOps 中設定動態饋給，擷取 Splunk Attack Analyzer 記錄

  1. 依序前往「SIEM 設定」>「動態饋給」。
  2. 按一下「新增動態消息」。
  3. 按一下「設定單一動態饋給」。
  4. 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如 Splunk Attack Analyzer Logs)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」。
  6. 選取「Splunk Attack Analyzer」做為「記錄類型」。

  7. 按一下「取得服務帳戶」。系統會顯示專屬服務帳戶電子郵件地址，例如：

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com

  8. 複製這個電子郵件地址，後續步驟會用到。

  9. 點選「下一步」。

  10. 指定下列輸入參數的值：

    • 儲存空間 bucket URL：輸入 GCS bucket URI，並加上前置路徑：

      gs://splunk-attack-analyzer-logs/saa/
      • 取代：
        • splunk-attack-analyzer-logs：您的 GCS bucket 名稱。
        • saa：儲存記錄的選用前置字元/資料夾路徑 (如為根目錄，請留空)。

    • 來源刪除選項：根據偏好設定選取刪除選項：

      • 永不：移轉後一律不刪除任何檔案 (建議用於測試)。
      • 刪除已轉移的檔案：成功轉移檔案後刪除檔案。

      • 刪除已轉移的檔案和空白目錄：成功轉移後刪除檔案和空白目錄。

    • 檔案存在時間上限：包含在過去天數內修改的檔案 (預設為 180 天)。

    • 資產命名空間：資產命名空間。

    • 擷取標籤：要套用至這個動態饋給事件的標籤。

  11. 點選「下一步」。

  12. 在「Finalize」(完成) 畫面中檢查新的動態饋給設定，然後按一下「Submit」(提交)。

將 IAM 權限授予 Google SecOps 服務帳戶

Google SecOps 服務帳戶需要 GCS bucket 的「Storage 物件檢視者」角色。

  1. 依序前往「Cloud Storage」>「Buckets」。
  2. 按一下 bucket 名稱 (splunk-attack-analyzer-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：貼上 Google SecOps 服務帳戶電子郵件地址。
    • 指派角色：選取「Storage 物件檢視者」。

  6. 按一下 [儲存]。

UDM 對應表

記錄欄位 UDM 對應 邏輯
時間 metadata.event_timestamp 事件發生時間
deviceName principal.hostname 主體的主機名稱
messageid metadata.id 事件的專屬 ID
動作 security_result.action 安全性產品採取的動作
通訊協定 network.ip_protocol IP 通訊協定
srcAddr principal.ip 主體的 IP 位址
srcPort principal.port 主體的通訊埠號碼
dstAddr target.ip 目標的 IP 位址
dstPort target.port 目標的通訊埠號碼
metadata.event_type 活動類型
metadata.product_name 產品名稱
metadata.vendor_name 供應商/公司名稱
Attack Analyzer metadata.product_name 從變更記錄對應
Splunk metadata.vendor_name 從變更記錄對應

變更記錄

查看這個剖析器的變更記錄

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求答案。