收集 NetDocuments 日志

支持的平台：

本文档介绍了如何使用 Google Cloud Storage V2 将 NetDocuments 日志注入到 Google Security Operations。

NetDocuments 是一款基于云的文档管理平台，专为法律和专业服务组织而设计。它通过 NetDocuments REST API 生成审核日志，用于跟踪文档访问、修改、共享和管理活动。

准备工作

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

  • Google SecOps 实例
  • 已启用 Cloud Storage API 的 GCP 项目
  • 创建和管理 GCS 存储分区的权限
  • 管理 GCS 存储分区的 IAM 政策的权限
  • 创建 Cloud Run 服务、Pub/Sub 主题和 Cloud Scheduler 作业的权限
  • 对 NetDocuments 的特权访问权限（代码库管理员或组织管理员角色）
  • 已注册 NetDocuments 应用并具有 OAuth2 凭据（客户端 ID、客户端密钥和刷新令牌）

创建 Google Cloud Storage 存储桶

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

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

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

  6. 点击创建。

收集 NetDocuments API 凭据

注册应用

  1. 使用管理员账号登录 NetDocuments 开发者门户。
  2. 前往应用，然后点击注册应用。
  3. 输入应用的名称（例如 Google Security Operations Integration）。
  4. 将应用类型设置为服务器（机密）。
  5. 请注意以下凭据：
    • 客户端 ID：OAuth2 客户端标识符
    • 客户端密钥：OAuth2 客户端密钥

生成刷新令牌

  1. 使用 NetDocuments OAuth2 授权流程获取刷新令牌。
  2. 使用所需范围授权应用：
    • read（对文档和审核日志的读取权限）
    • full（完全访问权限，如果贵组织要求）

  3. 完成 OAuth2 授权代码流程，并安全地保存刷新令牌。

确定 API 基准网址

NetDocuments API 基础网址取决于您的数据中心区域：

区域 API 基本网址
美国 https://api.netdocuments.com/v2
欧盟 https://api.eu.netdocuments.com/v2
AU https://api.au.netdocuments.com/v2

验证权限

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

  1. 登录 NetDocuments 管理员门户。
  2. 依次前往代码库管理 > 活动日志。
  3. 如果您能看到“活动日志”部分，则表示您拥有所需的权限。
  4. 如果您看不到此选项，请与 NetDocuments 管理员联系，以获取“知识库管理员”或“组织管理员”访问权限。

为 Cloud Run 函数创建服务账号

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

创建服务账号

  1. 在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
  2. 点击创建服务账号。
  3. 提供以下配置详细信息：
    • 服务账号名称：输入 netdocuments-logs-collector-sa
    • 服务账号说明：输入 Service account for Cloud Run function to collect NetDocuments 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. 点击您的存储桶名称（例如 netdocuments-audit-logs）。
  3. 前往权限标签页。
  4. 点击授予访问权限。
  5. 提供以下配置详细信息：
    • 添加主账号：输入服务账号电子邮件地址（例如 netdocuments-logs-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：输入 netdocuments-logs-trigger
    • 将其他设置保留为默认值
  4. 点击创建。

创建 Cloud Run 函数以收集日志

Cloud Run 函数将由来自 Cloud Scheduler 的 Pub/Sub 消息触发，以从 NetDocuments REST API 中提取日志并将其写入 GCS。

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

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

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

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

    1. 点击 + 添加触发器。
    2. 选择 Cloud Pub/Sub。
    3. 在选择 Cloud Pub/Sub 主题部分，选择主题 netdocuments-logs-trigger。
    4. 点击保存。

  6. 在身份验证部分中：

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

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

  8. 前往安全性标签页：

    • 服务账号：选择服务账号 netdocuments-logs-collector-sa。

  9. 前往容器标签页：

    1. 点击变量和密钥。
    2. 为每个环境变量点击+ 添加变量：
    变量名称 示例值 说明
    GCS_BUCKET netdocuments-audit-logs GCS 存储桶名称
    GCS_PREFIX netdocuments 日志文件的前缀
    STATE_KEY netdocuments/state.json 状态文件路径
    ND_API_BASE https://api.netdocuments.com/v2 NetDocuments API 基本网址
    ND_CLIENT_ID your-client-id OAuth2 客户端 ID
    ND_CLIENT_SECRET your-client-secret OAuth2 客户端密钥
    ND_REFRESH_TOKEN your-refresh-token OAuth2 刷新令牌
    MAX_RECORDS 5000 每次运行的记录数上限
    PAGE_SIZE 1000 每页记录数
    LOOKBACK_HOURS 24 初始回溯期

  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
import base64

# 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', 'netdocuments')
STATE_KEY = os.environ.get('STATE_KEY', 'netdocuments/state.json')
ND_API_BASE = os.environ.get('ND_API_BASE', 'https://api.netdocuments.com/v2')
ND_CLIENT_ID = os.environ.get('ND_CLIENT_ID')
ND_CLIENT_SECRET = os.environ.get('ND_CLIENT_SECRET')
ND_REFRESH_TOKEN = os.environ.get('ND_REFRESH_TOKEN')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000'))
LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24'))

def to_unix_millis(dt: datetime) -> int:
  """Convert datetime to Unix epoch milliseconds."""
  if dt.tzinfo is None:
    dt = dt.replace(tzinfo=timezone.utc)
  dt = dt.astimezone(timezone.utc)
  return int(dt.timestamp() * 1000)

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)

def get_access_token():
  """
  Obtain an OAuth2 access token using the refresh token.
  """
  token_url = "https://api.netdocuments.com/v1/OAuth"

  # Build Basic auth header
  credentials = base64.b64encode(
    f"{ND_CLIENT_ID}:{ND_CLIENT_SECRET}".encode('utf-8')
  ).decode('utf-8')

  headers = {
    'Authorization': f'Basic {credentials}',
    'Content-Type': 'application/x-www-form-urlencoded',
    'Accept': 'application/json'
  }

  body = f"grant_type=refresh_token&refresh_token={ND_REFRESH_TOKEN}"

  backoff = 1.0
  for attempt in range(3):
    response = http.request('POST', token_url, body=body, headers=headers)

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

    if response.status != 200:
      raise RuntimeError(f"Failed to get access token: {response.status} - {response.data.decode('utf-8')}")

    data = json.loads(response.data.decode('utf-8'))
    return data['access_token']

  raise RuntimeError("Failed to get access token after 3 retries")

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch NetDocuments
  audit logs and write to GCS.

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

  if not all([GCS_BUCKET, ND_CLIENT_ID, ND_CLIENT_SECRET, ND_REFRESH_TOKEN]):
    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"])
        # Overlap by 2 minutes to catch any delayed events
        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 logs from {last_time.isoformat()} to {now.isoformat()}")

    # Get access token
    token = get_access_token()

    # Fetch logs
    records, newest_event_time = fetch_logs(
      token=token,
      start_time=last_time,
      end_time=now,
      page_size=PAGE_SIZE,
      max_records=MAX_RECORDS,
    )

    if not records:
      print("No new log 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}/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}")

    # Update state with newest event time
    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(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_logs(token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int):
  """
  Fetch audit logs from NetDocuments REST API
  with pagination and rate limiting.

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

  Returns:
    Tuple of (records list, newest_event_time ISO string)
  """
  api_base = ND_API_BASE.rstrip('/')
  endpoint = f"{api_base}/AuditLog/search"

  headers = {
    'Authorization': f'Bearer {token}',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'User-Agent': 'GoogleSecOps-NetDocumentsCollector/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

    # Build request body
    body = {
      'startDate': start_time.strftime('%Y-%m-%dT%H:%M:%SZ'),
      'endDate': end_time.strftime('%Y-%m-%dT%H:%M:%SZ'),
      '$top': min(page_size, max_records - len(records)),
      '$skip': offset
    }

    try:
      response = http.request(
        'POST',
        endpoint,
        body=json.dumps(body),
        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 [], None

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

      page_results = data.get('results', data.get('value', []))

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

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

      # Track newest event time
      for event in page_results:
        try:
          event_ts = event.get('date') or event.get('timestamp') or event.get('created')
          if event_ts:
            event_time = str(event_ts)
            if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time):
              newest_time = event_time
        except Exception as e:
          print(f"Warning: Could not parse event time: {e}")

      # Check for more results
      offset += len(page_results)
      if len(page_results) < page_size:
        print("No more pages (partial page received)")
        break

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

  print(f"Retrieved {len(records)} total records from {page_num} pages")
  return records, newest_time
    • 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. 提供以下配置详细信息：

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

  4. 点击创建。

时间表频率选项

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

频率 Cron 表达式 使用场景
每隔 5 分钟 */5 * * * * 大批量、低延迟
每隔 15 分钟 */15 * * * * 搜索量中等
每小时 0 * * * * 标准（推荐）
每 6 小时 0 */6 * * * 低成交量、批处理
每天 0 0 * * * 历史数据收集

测试集成

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

  7. 验证函数是否已成功执行。请查找以下内容：

    Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
Page 1: Retrieved X events
Wrote X records to gs://netdocuments-audit-logs/netdocuments/logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

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

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

  10. 转到 netdocuments/ 文件夹。

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

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

  • HTTP 401：检查环境变量中的 OAuth2 凭据
  • HTTP 403：验证账号是否具有所需的“代码库管理员”或“组织管理员”权限
  • HTTP 429：速率限制 - 函数将自动重试并进行退避
  • 缺少环境变量：检查是否已设置所有必需的变量

在 Google SecOps 中配置 Feed 以注入 NetDocuments 日志

  1. 依次前往 SIEM 设置 > Feed。
  2. 点击添加新 Feed。
  3. 点击配置单个 Feed。
  4. 在 Feed 名称字段中，输入 Feed 的名称（例如 NetDocuments Logs）。
  5. 选择 Google Cloud Storage V2 作为来源类型。
  6. 选择 NetDocuments 作为日志类型。

  7. 点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址，例如：

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

  8. 复制此电子邮件地址。

  9. 点击下一步。

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

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

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

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

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

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

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

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

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

  11. 点击下一步。

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

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

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

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

UDM 映射表

日志字段 UDM 映射 逻辑
说明、名称 metadata.description 用户能够看懂的事件说明。
日期 metadata.event_timestamp 事件发生的时间。
metadata.event_type 事件的类型。
source.id principal.asset.hostname 与正文相关联的资产的主机名。
主机 principal.asset.ip 与正文相关联的资产的 IP 地址。
source.id principal.hostname 与正文相关联的主机名。
主机 principal.ip 与正文相关联的 IP 地址。
source.name principal.resource.attribute.labels 主账号资源的标签映射。
user.email principal.user.email_addresses 与用户关联的电子邮件地址。
user.memberType principal.user.role_name 用户的角色名称。
user.name principal.user.user_display_name 用户的显示名称。
user.id principal.user.userid 主账号的用户 ID。
storageObject.fileExtension target.file.mime_type 目标文件的 MIME 类型。
storageObject.name target.file.names 目标文件的名称。
storageObject.size target.file.size 目标文件的大小（以字节为单位）。
storageObject.version、storageObject.collabSpace、storageObject.NetBinder、storageObject.cabinet.name、storageObject.cabinet.id target.resource.attribute.labels 目标资源的标签映射。
storageObject.docId target.resource.product_object_id 目标资源的产品专用对象 ID。

更新日志

查看相应解析器的更改日志

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