收集 Team Cymru Scout 威胁情报日志

支持的平台：

Google SecOps SIEM

本文档介绍了如何使用 Google Cloud Storage 将 Team Cymru Scout 威胁情报数据提取到 Google Security Operations。Team Cymru Scout 提供威胁情报数据，包括账号使用情况指标、查询限制和基础查询统计信息，以帮助组织监控其安全状况和威胁情报消耗情况。

准备工作

确保您满足以下前提条件：

Google SecOps 实例
已启用 Cloud Storage API 的 GCP 项目
创建和管理 GCS 存储分区的权限
管理 GCS 存储分区的 IAM 政策的权限
创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
对 Team Cymru Scout 租户的特权访问权限

创建 Google Cloud Storage 存储分区

前往 Google Cloud 控制台。
选择您的项目或创建新项目。
在导航菜单中，依次前往 Cloud Storage > 存储分区。
点击创建存储分区。

提供以下配置详细信息：

设置	值
为存储分区命名	输入一个全局唯一的名称（例如 `team-cymru-scout-ti`）
位置类型	根据您的需求进行选择（区域级、双区域级、多区域级）
位置	选择相应位置（例如 `us-central1`）
存储类别	标准（建议用于经常访问的日志）
访问权限控制	统一（推荐）
保护工具	可选：启用对象版本控制或保留政策

点击创建。

收集 Team Cymru Scout API 凭据

登录 Team Cymru Scout Platform。
前往 API 密钥页面。
点击创建按钮。
根据需要提供密钥说明。
点击创建密钥按钮以生成 API 密钥。
复制以下详细信息并将其保存在安全的位置：
- SCOUT_API_TOKEN：API 访问令牌
- SCOUT_BASE_URL：Scout API 基准网址（通常为 https://scout.cymru.com）
注意： API 令牌将由 Cloud Run 函数使用，以通过 Authorization: Token <api_token> 标头格式向 Team Cymru Scout API 进行身份验证。Team Cymru Scout 还支持使用用户名/密码进行基本身份验证，作为令牌身份验证的替代方案，但此集成使用令牌身份验证。

测试 API 访问权限

在继续进行集成之前，请先测试您的凭据：

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

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个有权写入 GCS 存储分区的服务账号。

创建服务账号

在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
点击创建服务账号。
提供以下配置详细信息：
- 服务账号名称：输入 team-cymru-scout-ti-sa。
- 服务账号说明：输入 Service account for Cloud Run function to collect Team Cymru Scout Threat Intelligence data。
点击创建并继续。
在向此服务账号授予对项目的访问权限部分：
1. 点击选择角色。
2. 搜索并选择 Storage Object Admin。
3. 点击 + 添加其他角色。
4. 搜索并选择 Cloud Run Invoker。
5. 点击 + 添加其他角色。
6. 搜索并选择 Cloud Functions Invoker。
点击继续。
点击完成。

必须拥有这些角色，才能：

Storage Object Admin：将日志写入 GCS 存储分区并管理状态文件
Cloud Run Invoker：允许 Pub/Sub 调用函数
Cloud Functions Invoker：允许调用函数

授予对 GCS 存储分区的 IAM 权限

向服务账号授予对 GCS 存储分区的写入权限：

前往 Cloud Storage > 存储分区。
点击您的存储分区名称。
前往权限标签页。
点击授予访问权限。
提供以下配置详细信息：
- 添加主账号：输入服务账号电子邮件地址（例如 team-cymru-scout-ti-sa@PROJECT_ID.iam.gserviceaccount.com）。
- 分配角色：选择 Storage Object Admin。
点击保存。

创建发布/订阅主题

创建一个 Pub/Sub 主题，供 Cloud Scheduler 发布消息，并供 Cloud Run 函数订阅。

在 GCP 控制台中，前往 Pub/Sub > 主题。
点击创建主题。
提供以下配置详细信息：
- 主题 ID：输入 team-cymru-scout-ti-trigger。
- 将其他设置保留为默认值。
点击创建。

创建 Cloud Run 函数以收集威胁情报数据

Cloud Run 函数由来自 Cloud Scheduler 的 Pub/Sub 消息触发，用于从 Team Cymru Scout API 中提取威胁情报数据并将其写入 GCS。

在 GCP 控制台中，前往 Cloud Run。
点击创建服务。
选择函数（使用内嵌编辑器创建函数）。
在配置部分中，提供以下配置详细信息：

设置值

Service 名称 team-cymru-scout-ti-collector

区域选择与您的 GCS 存储分区匹配的区域（例如 us-central1）

运行时 选择 Python 3.12 或更高版本
在触发器（可选）部分中：
1. 点击 + 添加触发器。
2. 选择 Cloud Pub/Sub。
3. 在选择 Cloud Pub/Sub 主题中，选择主题 team-cymru-scout-ti-trigger。
4. 点击保存。
在身份验证部分中：
1. 选择需要进行身份验证。
2. 检查 Identity and Access Management (IAM)。
注意：调用函数时，Pub/Sub 会自动处理身份验证。
向下滚动并展开容器、网络、安全性。
前往安全标签页：
- 服务账号：选择服务账号 team-cymru-scout-ti-sa。

设置	值
Service 名称	`team-cymru-scout-ti-collector`
区域	选择与您的 GCS 存储分区匹配的区域（例如 `us-central1`）
运行时	选择 Python 3.12 或更高版本

前往容器标签页：

点击变量和密钥。
为每个环境变量点击 + 添加变量：

变量名称	示例值
`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`

在变量和密钥标签页中，向下滚动到请求：
- 请求超时：输入 600 秒（10 分钟）。
前往容器中的设置标签页：
- 在资源部分中：
  - 内存：选择 512 MiB 或更高值。
  - CPU：选择 1。
- 点击完成。
向下滚动到执行环境：
- 选择默认（推荐）。
在修订版本扩缩部分中：
- 实例数下限：输入 0。
- 实例数上限：输入 100（或根据预期负载进行调整）。
点击创建。
等待服务创建完成（1-2 分钟）。
创建服务后，系统会自动打开内嵌代码编辑器。

添加函数代码

在函数入口点中输入 main

在内嵌代码编辑器中，创建两个文件：

第一个文件：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}')

第二个文件：requirements.txt:：

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

点击部署以保存并部署该函数。
等待部署完成（2-3 分钟）。

注意： Pub/Sub 触发器配置会自动创建必要的订阅和权限。此实现使用已记录的 Team Cymru Scout API 端点 /api/scout/usage 和 Authorization: Token <api_token> 身份验证，如官方 Scout API 文档中所述。

创建 Cloud Scheduler 作业

Cloud Scheduler 会定期向 Pub/Sub 主题发布消息，从而触发 Cloud Run 函数。

在 GCP Console 中，前往 Cloud Scheduler。
点击创建作业。

提供以下配置详细信息：

设置	值
名称	`team-cymru-scout-ti-hourly`
区域	选择与 Cloud Run 函数相同的区域
频率	`0 * * * *`（每小时一次，在整点时）
时区	选择时区（建议选择世界协调时间 [UTC]）
目标类型	Pub/Sub
主题	选择主题 `team-cymru-scout-ti-trigger`
消息正文	`{}`（空 JSON 对象）

点击创建。

时间表频率选项

根据数据量和延迟时间要求选择频次：

频率	Cron 表达式	使用场景
每隔 5 分钟	`/5 * * *`	高频监控
每隔 15 分钟	`/15 * * *`	中频
每小时	`0 * * * *`	标准（推荐）
每 6 小时	`0 /6 * *`	低频
每天	`0 0 * * *`	每日用量跟踪

测试调度器作业

在 Cloud Scheduler 控制台中，找到您的作业。
点击强制运行以手动触发。
等待几秒钟，然后依次前往 Cloud Run > 服务 > team-cymru-scout-ti-collector > 日志。
验证函数是否已成功执行。
检查 GCS 存储分区，确认使用情况数据已写入。

检索 Google SecOps 服务账号

Google SecOps 使用唯一的服务账号从您的 GCS 存储分区中读取数据。您必须授予此服务账号对您的存储分区的访问权限。

获取服务账号电子邮件地址

依次前往 SIEM 设置 > Feed。
点击添加新 Feed。
点击配置单个 Feed。
在Feed 名称字段中，输入 Feed 的名称（例如 Team Cymru Scout Threat Intelligence）。
选择 Google Cloud Storage V2 作为来源类型。
选择 Team Cymru Scout 威胁情报作为日志类型。
点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址，例如：
```
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
```
复制此电子邮件地址，以便在下一步中使用。

注意：每个 Google SecOps 实例都有一个唯一的服务账号。请勿使用其他文档或示例中的服务账号。

向 Google SecOps 服务账号授予 IAM 权限

Google SecOps 服务账号需要对您的 GCS 存储分区具有 Storage Object Viewer 角色。

前往 Cloud Storage > 存储分区。
点击您的存储分区名称。
前往权限标签页。
点击授予访问权限。
提供以下配置详细信息：
- 添加主账号：粘贴 Google SecOps 服务账号电子邮件地址。
- 分配角色：选择 Storage Object Viewer。
点击保存。

注意：如果您打算使用“删除已转移的文件”或“删除已转移的文件和空目录”删除选项，请授予存储对象管理员角色，而不是存储对象查看者角色。

在 Google SecOps 中配置 Feed 以注入 Team Cymru Scout 威胁情报数据

依次前往 SIEM 设置 > Feed。
点击添加新 Feed。
点击配置单个 Feed。
在Feed 名称字段中，输入 Feed 的名称（例如 Team Cymru Scout Threat Intelligence）。
选择 Google Cloud Storage V2 作为来源类型。
选择 Team Cymru Scout 威胁情报作为日志类型。
点击下一步。
为以下输入参数指定值：
- 存储分区网址：输入带有前缀路径的 GCS 存储分区 URI：
```
gs://team-cymru-scout-ti/team-cymru/scout-ti/
```
  - 将
    - team-cymru-scout-ti：您的 GCS 存储分区名称。
    - team-cymru/scout-ti/：存储日志的前缀/文件夹路径。
  注意：请务必在 URI 末尾添加尾随斜杠 (/)。
- 来源删除选项：根据您的偏好选择删除选项：
  - 永不：永不删除转移后的任何文件（建议用于测试）。
  - 删除已转移的文件：在成功转移后删除文件。
  - 删除已转移的文件和空目录：在成功转移后删除文件和空目录。
    
    注意：如果您选择删除选项，服务账号必须具有 Storage Object Admin 角色，而不是 Storage Object Viewer 角色。相应地更新 IAM 权限。
- 文件存在时间上限：包含在过去指定天数内修改的文件。默认值为 180 天。
- 资产命名空间：资产命名空间。
- 注入标签：要应用于此 Feed 中事件的标签。
点击下一步。
在最终确定界面中查看新的 Feed 配置，然后点击提交。