收集 SpyCloud 記錄

支援的國家/地區：

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

SpyCloud 是一個帳戶盜用防護平台，可提供外洩和遭竊憑證的相關資訊。透過 REST API 提供違規記錄、監控清單快訊和遭盜用憑證報表。

事前準備

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

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage API 的 GCP 專案
  • 建立及管理 GCS bucket 的權限
  • 管理 Google Cloud Storage 值區 IAM 政策的權限
  • 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • 具備 API 存取權和有效 API 金鑰的 SpyCloud 帳戶

建立 Google Cloud Storage bucket

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

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

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

  6. 點選「建立」。

收集 SpyCloud API 憑證

取得 API 金鑰

  1. 以管理員身分登入 SpyCloud 入口網站。
  2. 依序前往「設定」>「API」。
  3. 複製並將 API 金鑰儲存在安全位置。

驗證權限

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

  1. 登入 SpyCloud 入口網站。
  2. 依序前往「設定」>「API」。
  3. 確認 API 金鑰有效，且有權存取必要端點 (違規資料、監控清單、指南針)。
  4. 如果存取權受到限制，請與 SpyCloud 管理員聯絡。

測試 API 存取權

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

    # 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"

為 Cloud Run 函式建立服務帳戶

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

建立服務帳戶

  1. 在 GCP 控制台中，依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  2. 按一下「Create Service Account」(建立服務帳戶)。
  3. 請提供下列設定詳細資料：
    • 服務帳戶名稱：輸入 spycloud-collector-sa。
    • 服務帳戶說明：輸入 Service account for Cloud Run function to collect SpyCloud 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 名稱 (例如 spycloud-logs)。
  3. 前往「權限」分頁標籤。
  4. 按一下「授予存取權」。
  5. 請提供下列設定詳細資料：
    • 新增主體：輸入服務帳戶電子郵件地址 (例如 spycloud-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：輸入 spycloud-trigger。
    • 其他設定保留預設值。
  4. 點選「建立」。

建立 Cloud Run 函式來收集記錄

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

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

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

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

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

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

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

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

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

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

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

  9. 前往「容器」分頁：

    1. 按一下「變數與密鑰」。
    2. 針對每個環境變數，按一下「+ 新增變數」：
    變數名稱 範例值 說明
    GCS_BUCKET spycloud-logs GCS bucket 名稱
    GCS_PREFIX spycloud 記錄檔的前置字串
    STATE_KEY spycloud/state.json 狀態檔案路徑
    API_KEY your-api-key SpyCloud API 金鑰
    API_BASE https://api.spycloud.io API 基準網址
    MAX_RECORDS 10000 每次執行的記錄數上限
    LOOKBACK_DAYS 7 初始回溯期 (以天為單位)
    STREAMS watchlist,catalog 以半形逗號分隔的資料串流

  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', '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)

    • 第二個檔案：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. 請提供下列設定詳細資料：

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

  4. 點選「建立」。

排程頻率選項

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

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

測試整合項目

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

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

    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}

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

如果記錄中顯示錯誤：

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

在 Google SecOps 中設定動態饋給，擷取 SpyCloud 記錄

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

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

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

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

  9. 點選「下一步」。

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

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

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

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

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

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

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

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

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

  11. 點選「下一步」。

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

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

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

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

  6. 按一下 [儲存]。

UDM 對應表

記錄欄位 UDM 對應 邏輯
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 從這些欄位和 av_software_list 建立的標籤合併而來
密碼 extensions.auth.auth_details 直接複製值
時間 metadata.event_timestamp 剖析為 ISO8601 時間戳記
metadata.event_type 根據條件設定：如果具有主體、目標和網路，則為 NETWORK_CONNECTION；如果具有主體和主體使用者 ID，則為 USER_UNCATEGORIZED；如果具有主體但沒有主體 IP，則為 STATUS_UPDATE；否則為 GENERIC_EVENT；如果存在使用者主機名稱、IP 或受感染的機器 ID，則為 USER_UNCATEGORIZED
infected_time metadata.ingested_timestamp 以時間戳記形式剖析，格式為 yyyy-MM-ddTHH:mm:ssZ、RFC 3339、ISO8601
log_id、assets.log_id、uuid metadata.product_log_id 如果 log_id 不為空值，則為 log_id 的值；否則為 assets.log_id，否則為 uuid
user_os network.http.parsed_user_agent 已轉換為剖析的使用者代理程式
user_os network.http.user_agent 直接複製值
cookie_domain principal.administrative_domain 直接複製值
國家/地區 principal.asset.location.country_or_region 直接複製值
infected_machine_id principal.asset_id 串連為「id: 」+ 受感染的電腦 ID
infected_path principal.file.full_path 直接複製值
user_hostname、domain principal.hostname 如果 user_hostname 不為空白，則設為該值；如果 domain 不為空白，則設為該值
ip、ip_addresses principal.ip 從 ip 和 ip_addresses 陣列合併
country_code principal.resource.attribute.labels 從 country_code 建立的 country_code_label 合併
id principal.resource.id 直接複製值 (已轉換為字串)
首頁 principal.url 直接複製值
電子郵件 principal.user.email_addresses 直接複製值
full_name principal.user.user_display_name 直接複製值
user_sys_registered_owner、email_username principal.user.userid 設為 user_sys_registered_owner，然後設為 email_username (如不為空)
信心 security_result.confidence_details 已轉換為字串
說明 security_result.description 直接複製值
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 從根據這些欄位建立的標籤合併
嚴重性 security_result.severity 如果為「2」，請設為「LOW」；如果為「5」，請設為「INFORMATIONAL」；如果為「20」，請設為「HIGH」；如果為「25」或「26」，請設為「CRITICAL」
嚴重性 security_result.severity_details 直接複製值
target_subdomain target.administrative_domain 直接複製值
target_domain target.asset.hostname 直接複製值
target_domain target.hostname 直接複製值
target_url target.url 直接複製值
使用者名稱 target.user.userid 直接複製值
metadata.product_name 設為「SPYCLOUD」
metadata.vendor_name 設為「SpyCloud」
spycloud_publish_date", "infected_time", and "timezone security_result.detection_fields 從變更記錄對應

變更記錄

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

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