收集 Nucleus Asset Metadata 日志

支持的平台：

本文档介绍了如何使用 Google Cloud Storage V2 将 Nucleus Security 资产元数据日志注入到 Google Security Operations。

Nucleus Security 是一个漏洞管理平台，可汇总并确定多个扫描器的资产元数据的优先级，从而提供组织安全状况的统一视图。解析器从 Nucleus 资产数据中提取字段，并将其映射到统一数据模型 (UDM)，从而捕获资产身份、IP 地址、主机名和漏洞得分。

准备工作

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

  • Google SecOps 实例
  • 已启用 Cloud Storage API 的 GCP 项目
  • 创建和管理 GCS 存储分区的权限
  • 管理 GCS 存储分区的 IAM 政策的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 通过管理员权限和 API 密钥访问权限对 Nucleus Security 进行特权访问

创建 Google Cloud Storage 存储桶

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

  5. 提供以下配置详细信息：

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

  6. 点击创建。

收集 Nucleus Security API 凭据

生成 API 密钥

  1. 使用管理员凭据登录 Nucleus Security 平台。
  2. 前往设置 > API 密钥。
  3. 点击 Generate API Key。
  4. 输入密钥的标签（例如 Google Security Operations Integration）。

  5. 复制并妥善存储 API 密钥。

确定项目 ID

  1. 登录 Nucleus Security 平台。
  2. 前往项目。
  3. 点击要从中收集资源数据的项目。
  4. 记下网址或项目设置页面中的项目 ID。

验证权限

如需验证 API 密钥是否具有所需权限，请执行以下操作：

  1. 登录 Nucleus Security 平台。
  2. 前往设置 > API 密钥。
  3. 确认您生成的 API 密钥已列出，且状态为有效。
  4. 验证密钥是否对目标项目具有读取权限。

测试 API 访问权限

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

    # Replace with your actual credentials
API_KEY="<your-api-key>"
PROJECT_ID="<your-project-id>"

# Test API access - list assets
curl -v -H "x-apikey: ${API_KEY}" \
  "https://app.nucleussec.com/nucleus/api/v1/projects/${PROJECT_ID}/assets?start=0&limit=10"

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个服务账号，该账号具有写入 GCS 存储桶的权限，并且可以由 Pub/Sub 调用。

创建服务账号

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

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

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

授予对 GCS 存储桶的 IAM 权限

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

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

创建 Pub/Sub 主题

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

  1. 在 GCP 控制台中，前往 Pub/Sub > 主题。
  2. 点击创建主题。
  3. 提供以下配置详细信息：
    • 主题 ID：输入 nucleus-asset-trigger
    • 将其他设置保留为默认值
  4. 点击创建。

创建 Cloud Run 函数以收集日志

Cloud Run 函数将由来自 Cloud Scheduler 的 Pub/Sub 消息触发，以从 Nucleus Security API 中提取资产元数据并将其写入 GCS。

  1. 在 GCP 控制台中，前往 Cloud Run。
  2. 点击创建服务。
  3. 选择函数（使用内嵌编辑器创建函数）。

  4. 在配置部分中，提供以下配置详细信息：

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

  5. 在触发器（可选）部分中：

    1. 点击 + 添加触发器。
    2. 选择 Cloud Pub/Sub。
    3. 在选择 Cloud Pub/Sub 主题中，选择 Pub/Sub 主题 (nucleus-asset-trigger)。
    4. 点击保存。

  6. 在身份验证部分中：

    1. 选择需要进行身份验证。
    2. 检查 Identity and Access Management (IAM)。

  7. 向下滚动并展开容器、网络、安全性。

  8. 前往安全性标签页：

    • 服务账号：选择服务账号 (nucleus-asset-collector-sa)

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击+ 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET nucleus-asset-logs GCS 存储桶名称
    GCS_PREFIX nucleus-assets 日志文件的前缀
    STATE_KEY nucleus-assets/state.json 状态文件路径
    API_KEY your-api-key Nucleus Security API 密钥
    PROJECT_ID your-project-id Nucleus Security 项目 ID
    MAX_RECORDS 5000 每次运行的记录数上限
    PAGE_SIZE 1000 每页记录数（最多 1000 条）

  10. 在变量和 Secret 部分中，向下滚动到请求：

    • 请求超时：输入 600 秒（10 分钟）

  11. 前往设置标签页：

    • 在资源部分中：
      • 内存：选择 512 MiB 或更高值
      • CPU：选择 1

  12. 在修订版本伸缩部分中：

    • 实例数下限：输入 0
    • 实例数上限：输入 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', 'nucleus-assets')
STATE_KEY = os.environ.get('STATE_KEY', 'nucleus-assets/state.json')
API_KEY = os.environ.get('API_KEY')
PROJECT_ID = os.environ.get('PROJECT_ID')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000'))

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch Nucleus Security
  asset metadata and write to GCS.

  Args:
    cloud_event: CloudEvent object containing Pub/Sub message
  """

  if not all([GCS_BUCKET, API_KEY, PROJECT_ID]):
    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)

    now = datetime.now(timezone.utc)
    print(f"Starting asset metadata collection at {now.isoformat()}")

    # Fetch assets
    records, total = fetch_assets(
      api_key=API_KEY,
      project_id=PROJECT_ID,
      page_size=PAGE_SIZE,
      max_records=MAX_RECORDS,
    )

    if not records:
      print("No asset 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}/assets_{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}")

    # Update state
    save_state(bucket, STATE_KEY, now.isoformat())

    print(f"Successfully processed {len(records)} asset 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_assets(api_key: str, project_id: str, page_size: int, max_records: int):
  """
  Fetch asset metadata from Nucleus Security API with pagination.

  Args:
    api_key: Nucleus Security API key
    project_id: Nucleus project ID
    page_size: Number of records per page (max 1000)
    max_records: Maximum total records to fetch

  Returns:
    Tuple of (records list, total count)
  """
  endpoint = f"https://app.nucleussec.com/nucleus/api/v1/projects/{project_id}/assets"

  headers = {
    'x-apikey': api_key,
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'User-Agent': 'GoogleSecOps-NucleusAssetCollector/1.0',
  }

  records = []
  page_num = 0
  backoff = 1.0
  start_index = 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}?start={start_index}&limit={current_limit}"

    try:
      response = http.request('GET', url, headers=headers)

      # Handle rate limiting with exponential backoff
      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 [], 0

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

      # Nucleus API returns a list of assets directly
      if isinstance(data, list):
        page_results = data
      else:
        page_results = data.get('assets', data.get('results', []))

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

      print(f"Page {page_num}: Retrieved {len(page_results)} assets")
      records.extend(page_results)

      # Check for more results
      if len(page_results) < current_limit:
        print(f"Reached last page (size={len(page_results)} < limit={current_limit})")
        break

      start_index += len(page_results)

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

  print(f"Retrieved {len(records)} total assets from {page_num} pages")
  return records, len(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 Console 中，前往 Cloud Scheduler。
  2. 点击创建作业。

  3. 提供以下配置详细信息：

    设置 值
    名称 nucleus-asset-collector-daily
    区域 选择与 Cloud Run 函数相同的区域
    频率 0 0 * * *（每天午夜）
    时区 选择时区（建议选择世界协调时间 [UTC]）
    目标类型 Pub/Sub
    主题 选择 Pub/Sub 主题 (nucleus-asset-trigger)
    消息正文 {}（空 JSON 对象）

  4. 点击创建。

时间表频率选项

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

频率 Cron 表达式 使用场景
每隔 5 分钟 */5 * * * * 大批量、低延迟
每隔 15 分钟 */15 * * * * 搜索量中等
每小时 0 * * * * 标准
每 6 小时 0 */6 * * * 低成交量、批处理
每天 0 0 * * * 资产清单快照（推荐）

测试集成

  1. 在 Cloud Scheduler 控制台中，找到您的作业。
  2. 点击强制运行以手动触发作业。
  3. 等待几秒钟。
  4. 前往 Cloud Run > 服务。
  5. 点击函数名称 (nucleus-asset-collector)。
  6. 点击日志标签页。

  7. 验证函数是否已成功执行。查找：

    Starting asset metadata collection at YYYY-MM-DDTHH:MM:SS+00:00
Page 1: Retrieved X assets
Wrote X records to gs://nucleus-asset-logs/nucleus-assets/assets_YYYYMMDD_HHMMSS.ndjson
Successfully processed X asset records

  8. 前往 Cloud Storage > 存储分区。

  9. 点击您的存储桶名称 (nucleus-asset-logs)。

  10. 前往前缀文件夹 (nucleus-assets/)。

  11. 验证是否已创建具有当前时间戳的新 .ndjson 文件。

如果您在日志中看到错误，请执行以下操作：

  • HTTP 401：检查环境变量中的 API 密钥
  • HTTP 403：验证 API 密钥是否具有项目的读取权限
  • HTTP 429：速率限制 - 函数将自动重试并进行退避
  • 缺少环境变量：检查是否已设置所有必需的变量

检索 Google SecOps 服务账号

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

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

  1. 依次前往 SIEM 设置 > Feed。
  2. 点击添加新 Feed。
  3. 点击配置单个 Feed。
  4. 在 Feed 名称字段中，输入 Feed 的名称（例如 Nucleus Asset Metadata Logs）。
  5. 选择 Google Cloud Storage V2 作为来源类型。
  6. 选择 Nucleus 资产元数据作为日志类型。
  7. 点击获取服务账号。

  8. 系统会显示一个唯一的服务账号电子邮件地址，例如：

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

  9. 复制此电子邮件地址，以便在下一步中使用。

  10. 点击下一步。

  11. 为以下输入参数指定值：

    • 存储桶网址：输入带有前缀路径的 GCS 存储桶 URI：

      gs://nucleus-asset-logs/nucleus-assets/
      • 替换：
        • nucleus-asset-logs：您的 GCS 存储桶名称。
        • nucleus-assets：存储日志的可选前缀/文件夹路径（留空表示根目录）。

    • 来源删除选项：根据您的偏好选择删除选项：

      • 永不：转移后永不删除任何文件（建议用于测试）。
      • 删除已转移的文件：在成功转移后删除文件。

      • 删除已转移的文件和空目录：成功转移后删除文件和空目录。

    • 文件存在时间上限：包含在过去指定天数内修改的文件（默认值为 180 天）

    • 资产命名空间：资产命名空间

    • 注入标签：要应用于此 Feed 中事件的标签

  12. 点击下一步。

  13. 在最终确定界面中查看新的 Feed 配置，然后点击提交。

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

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

  1. 前往 Cloud Storage > 存储分区。
  2. 点击您的存储桶名称（例如 nucleus-asset-logs）。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：粘贴 Google SecOps 服务账号电子邮件地址
    • 分配角色：选择 Storage Object Viewer

  6. 点击保存。

UDM 映射表

日志字段 UDM 映射 逻辑
host_score_total、host_complianced_score、host_data_sensitivity_score、host_public、asset_tags entity.asset.attribute.labels 从 host_score_total 合并的标签为“Host Score Total”，从 host_complianced_score 合并的标签为“Host Complianced Score”，从 host_data_sensitivity_score 合并的标签为“Host Data Sensitivity Score”，从 host_public 合并的标签为“Host Public”，以及解析为键值对的 asset_tags
asset_name entity.asset.hostname 如果包含“http”，则使用 grok 模式从 asset_name 中提取
ip_address entity.asset.ip 从 ip_address 合并
asset_id entity.asset.product_object_id 如果不为空，则直接复制值
asset_name entity.url 如果包含“http”且 url_path 不为空，则使用 grok 模式从 asset_name 中提取
metadata.entity_type 设置为“ASSET”
metadata.product_name 设置为“Nucleus Unified Vulnerability Management”
metadata.vendor_name 设置为“NUCLEUS”

需要更多帮助？获得社区成员和 Google SecOps 专业人士的解答。