收集 Aware 审核日志

支持的平台：

Google SecOps SIEM

本文档介绍了如何使用 Google Cloud Storage 将 Aware 审核日志提取到 Google Security Operations。Aware 是一个协作智能平台，可为企业协作工具提供数据洞见和治理功能。

准备工作

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

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

收集 Aware API 前提条件

登录 Aware 管理控制台。
依次前往系统设置> 集成 > API 令牌。
点击 + API 令牌，然后授予审核日志只读权限。
复制以下详细信息并将其保存在安全的位置：
- API 令牌
- API 基准网址：端点为 https://api.aware.work/external/system/auditlogs/v1
注意： Aware 管理员控制台中显示的 API 基本网址应与 https://api.aware.work/external/system/auditlogs/v1 一致。如果您的租户使用其他基本网址，您将需要更新函数代码中的 AWARE_ENDPOINT 常量。

创建 Google Cloud Storage 存储分区

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

提供以下配置详细信息：

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

点击创建。

为 Cloud Run 函数创建服务账号

Cloud Run 函数需要一个服务账号，该账号具有向 GCS 存储分区写入内容以及被 Pub/Sub 调用的权限。

创建服务账号

在 GCP 控制台中，依次前往 IAM 和管理 > 服务账号。
点击创建服务账号。
提供以下配置详细信息：
- 服务账号名称：输入 aware-audit-poller-sa。
- 服务账号说明：输入 Service account for Cloud Run function to collect Aware audit logs。
点击创建并继续。
在向此服务账号授予对项目的访问权限部分中，添加以下角色：
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 > 存储分区。
点击您的存储分区名称。
前往权限标签页。
点击授予访问权限。
提供以下配置详细信息：
- 添加主账号：输入服务账号电子邮件地址（例如 aware-audit-poller-sa@PROJECT_ID.iam.gserviceaccount.com）。
- 分配角色：选择 Storage Object Admin。
点击保存。

创建发布/订阅主题

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

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

创建 Cloud Run 函数以收集日志

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

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

设置值

Service 名称 aware-audit-poller

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

运行时 选择 Python 3.12 或更高版本
在触发器（可选）部分中：
1. 点击 + 添加触发器。
2. 选择 Cloud Pub/Sub。
3. 在选择 Cloud Pub/Sub 主题部分，选择主题 aware-audit-trigger。
4. 点击保存。
在身份验证部分中：
1. 选择需要进行身份验证。
2. 检查 Identity and Access Management (IAM)。
注意：调用函数时，Pub/Sub 会自动处理身份验证。
向下滚动并展开容器、网络、安全性。
前往安全标签页：
- 服务账号：选择服务账号 aware-audit-poller-sa。
前往容器标签页：
1. 点击变量和密钥。
2. 为每个环境变量点击 + 添加变量：
  
  变量名称示例值
  
  GCS_BUCKET aware-audit-logs
  
  GCS_PREFIX aware/audit/
  
  STATE_KEY aware/state.json
  
  AWARE_API_TOKEN your-aware-api-token
  
  MAX_PER_PAGE 500
在变量和密钥标签页中，向下滚动到请求：
- 请求超时：输入 600 秒（10 分钟）。
前往容器中的设置标签页：
- 在资源部分中：
  - 内存：选择 512 MiB 或更高值。
  - CPU：选择 1。
- 点击完成。
滚动到执行环境：
- 选择默认（推荐）。
在修订版本扩缩部分中：
- 实例数下限：输入 0。
- 实例数上限：输入 100（或根据预期负载进行调整）。
点击创建。
等待服务创建完成（1-2 分钟）。
创建服务后，系统会自动打开内嵌代码编辑器。

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

变量名称	示例值
`GCS_BUCKET`	`aware-audit-logs`
`GCS_PREFIX`	`aware/audit/`
`STATE_KEY`	`aware/state.json`
`AWARE_API_TOKEN`	`your-aware-api-token`
`MAX_PER_PAGE`	`500`

添加函数代码

在函数入口点中输入 main

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

第一个文件：main.py:：

import functions_framework
from google.cloud import storage
import json
import os
import urllib3
from datetime import datetime, timedelta, timezone
import gzip
import io
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()

AWARE_ENDPOINT = "https://api.aware.work/external/system/auditlogs/v1"

@functions_framework.cloud_event
def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch Aware audit logs 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', 'aware/audit/')
    state_key = os.environ.get('STATE_KEY', 'aware/state.json')
    api_token = os.environ.get('AWARE_API_TOKEN')
    max_per_page = int(os.environ.get('MAX_PER_PAGE', '500'))

    if not all([bucket_name, api_token]):
        print('Error: Missing required environment variables')
        return

    try:
        # Get GCS bucket
        bucket = storage_client.bucket(bucket_name)

        # Load state
        state = load_state(bucket, state_key)

        tz_utc = timezone.utc
        now = datetime.now(tz=tz_utc)

        start_date = (
            datetime.fromisoformat(state['last_date']).date()
            if 'last_date' in state
            else (now - timedelta(days=1)).date()
        )
        end_date = now.date()

        total = 0
        day = start_date
        backoff = 1.0

        while day <= end_date:
            day_str = day.strftime('%Y-%m-%d')
            params = {
                'filter': f'startDate:{day_str},endDate:{day_str}',
                'limit': str(max_per_page)
            }
            offset = 1

            out = io.BytesIO()
            with gzip.GzipFile(filename='aware_audit.jsonl', mode='wb', fileobj=out) as gz:
                wrote_any = False

                while True:
                    # Build query URL
                    query_params = {**params, 'offset': str(offset)}
                    query_string = '&'.join([f'{k}={v}' for k, v in query_params.items()])
                    url = f'{AWARE_ENDPOINT}?{query_string}'

                    # Make API request
                    headers = {'X-Aware-Api-Key': api_token}

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

                        # 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'Error: API returned status {response.status}')
                            break

                        payload = json.loads(response.data.decode('utf-8'))
                        items = (payload.get('value') or {}).get('auditLogData') or []

                        if not items:
                            break

                        for item in items:
                            gz.write((json.dumps(item, separators=(',', ':')) + '\n').encode('utf-8'))
                            total += 1
                            wrote_any = True

                        offset += 1

                    except Exception as e:
                        print(f'Error fetching page: {str(e)}')
                        break

            if wrote_any:
                blob_name = f"{prefix}{day.strftime('%Y/%m/%d')}/aware_audit_{now.strftime('%Y%m%d_%H%M%S')}.jsonl.gz"
                blob = bucket.blob(blob_name)
                blob.upload_from_string(
                    out.getvalue(),
                    content_type='application/json',
                    content_encoding='gzip'
                )
                print(f'Wrote {total} logs to {blob_name}')

            save_state(bucket, state_key, {'last_date': day.isoformat()})
            day += timedelta(days=1)

        print(f'Successfully processed {total} logs')

    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: {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),
            content_type='application/json'
        )
    except Exception as e:
        print(f'Warning: Could not save state: {str(e)}')

第二个文件：requirements.txt:：

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

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

创建 Cloud Scheduler 作业

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

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

提供以下配置详细信息：

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

点击创建。

时间表频率选项

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

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

测试调度器作业

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

检索 Google SecOps 服务账号

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

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

依次前往 SIEM 设置 > Feed。
点击添加新 Feed。
点击配置单个 Feed。
在Feed 名称字段中，输入 Feed 的名称（例如 Aware Audit logs）。
选择 Google Cloud Storage V2 作为来源类型。
选择 Aware 审核作为日志类型。
点击获取服务账号。系统会显示一个唯一的服务账号电子邮件地址，例如：
```
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 以提取 Aware 审核日志

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