收集 Jamf Pro 上下文日志

支持的平台：

Google SecOps SIEM

本文档介绍了如何使用 Cloud Storage、Cloud Run functions、Pub/Sub 和 Cloud Scheduler 将 Jamf Pro 上下文日志（设备和用户上下文）注入到 Google Security Operations。Jamf Pro 是一款全面的 Apple 设备管理解决方案，可提供设备清单、用户情境和配置管理功能。

准备工作

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

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

配置 Jamf API 角色

1. 登录 Jamf 网页界面。
2. 依次前往设置 > 系统部分 > API 角色和客户端。
3. 选择 API 角色标签页。
4. 点击 New（新建）。
5. 输入 API 角色的显示名称（例如 context_role）。

6. 在 Jamf Pro API 角色权限中，输入权限名称，然后从菜单中选择该权限：

   • 计算机资产清单
   • 移动设备资产清单
   注意： 您可以继续添加更多权限，直到完成为止。

7. 点击保存。

配置 Jamf API 客户端

1. 在 Jamf Pro 中，依次前往设置 >“系统”部分 >“API 角色和客户端”。
2. 选择 API 客户端标签页。
3. 点击 New（新建）。
4. 输入 API 客户端的显示名称（例如 context_client）。
5. 在 API Roles 字段中，添加您之前创建的 context_role 角色。
6. 在访问令牌生命周期下，输入访问令牌的有效时间（以秒为单位）。
7. 点击保存。
8. 点击修改。
9. 点击启用 API 客户端。
10. 点击保存。

配置 Jamf 客户端密钥

1. 在 Jamf Pro 中，前往新创建的 API 客户端。
2. 点击 Generate Client Secret（生成客户端 Secret）。
3. 在确认界面中，点击创建密钥。
4. 将以下参数保存在安全的位置：
   • 基础网址：https://<your>.jamfcloud.com
   • 客户端 ID：UUID。
   • 客户端密钥：该值仅显示一次。

创建 Cloud Storage 存储桶

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

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

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

6. 点击创建。

为 Cloud Run 函数创建服务账号

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

创建服务账号

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

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

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

授予对 Cloud Storage 存储桶的 IAM 权限

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

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

创建 Pub/Sub 主题

创建一个 Pub/Sub 主题，Cloud Scheduler 将向该主题发布消息，而 Cloud Run 函数将订阅该主题。

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

创建 Cloud Run 函数以收集日志

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

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

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

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

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

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

6. 在身份验证部分中：

   1. 选择需要进行身份验证。
   2. 检查Identity and Access Management (IAM)。
   注意： 调用函数时，Pub/Sub 会自动处理身份验证。

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

8. 前往安全性标签页：

   • 服务账号：选择服务账号 (jamf-pro-collector-sa)。

9. 前往容器标签页：

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

   变量名称	示例值
   GCS_BUCKET	jamfpro
   GCS_PREFIX	jamf-pro/context/
   JAMF_CLIENT_ID	输入 Jamf 客户端 ID
   JAMF_CLIENT_SECRET	输入 Jamf 客户端密钥
   JAMF_BASE_URL	输入 Jamf 网址，将 https://<your>.jamfcloud.com 中的 <your> 替换为
   PAGE_SIZE	200

10. 在变量和密钥标签页中，向下滚动到请求：

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

11. 前往容器中的设置标签页：

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

12. 向下滚动到执行环境：

    • 选择默认（推荐）。

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

    • 实例数下限：输入 0。
    • 实例数上限：输入 100（或根据预期负载进行调整）。

14. 点击创建。

15. 等待服务创建完成（1-2 分钟）。

16. 创建服务后，系统会自动打开内嵌代码编辑器。

添加函数代码

1. 在函数入口点中输入 main

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

   • 第一个文件：main.py:：

   import functions_framework
   from google.cloud import storage
   import json
   import os
   import urllib3
   from datetime import datetime, timezone
   import gzip
   import io
   import time
   
   # Initialize HTTP client
   http = urllib3.PoolManager()
   
   # Initialize Storage client
   storage_client = storage.Client()
   
   # Configuration
   BASE_URL = os.environ.get("JAMF_BASE_URL", "").rstrip("/")
   CLIENT_ID = os.environ.get("JAMF_CLIENT_ID")
   CLIENT_SECRET = os.environ.get("JAMF_CLIENT_SECRET")
   GCS_BUCKET = os.environ.get("GCS_BUCKET")
   GCS_PREFIX = os.environ.get("GCS_PREFIX", "jamf-pro/context/")
   PAGE_SIZE = int(os.environ.get("PAGE_SIZE", "200"))
   
   SECTIONS = [
       "GENERAL", "HARDWARE", "OPERATING_SYSTEM", "USER_AND_LOCATION",
       "DISK_ENCRYPTION", "SECURITY", "EXTENSION_ATTRIBUTES", "APPLICATIONS",
       "CONFIGURATION_PROFILES", "LOCAL_USER_ACCOUNTS", "CERTIFICATES",
       "SERVICES", "PRINTERS", "SOFTWARE_UPDATES", "GROUP_MEMBERSHIPS",
       "CONTENT_CACHING", "STORAGE", "FONTS", "PACKAGE_RECEIPTS",
       "PLUGINS", "ATTACHMENTS", "LICENSED_SOFTWARE", "IBEACONS", "PURCHASING"
   ]
   
   # Cached access token, refreshed shortly before it expires
   _token_cache = {"value": None, "expires_at": 0.0}
   
   def get_token():
       """OAuth2 client credentials > access_token"""
       url = f"{BASE_URL}/api/oauth/token"
   
       fields = {
           "grant_type": "client_credentials",
           "client_id": CLIENT_ID,
           "client_secret": CLIENT_SECRET
       }
   
       # encode_multipart=False is required. It sends a real
       # application/x-www-form-urlencoded body, which is what the Jamf token
       # endpoint expects. Without it, urllib3 sends a multipart/form-data body
       # and Jamf cannot read grant_type, client_id and client_secret.
       response = http.request(
           'POST',
           url,
           fields=fields,
           encode_multipart=False,
           timeout=30.0
       )
   
       if response.status != 200:
           raise Exception(f"Failed to get token: {response.status} {response.data.decode('utf-8')}")
   
       data = json.loads(response.data.decode('utf-8'))
       return data["access_token"], int(data.get("expires_in", 1200))
   
   def get_valid_token():
       """Return a cached token, refreshing it before it expires."""
       now = time.time()
       if _token_cache["value"] and now < _token_cache["expires_at"] - 60:
           return _token_cache["value"]
   
       token, ttl = get_token()
       _token_cache["value"] = token
       _token_cache["expires_at"] = now + ttl
       return token
   
   def fetch_page(token, page):
       """GET /api/v1/computers-inventory with sections & pagination"""
       url = f"{BASE_URL}/api/v1/computers-inventory"
   
       # Build query parameters
       params = [("page", str(page)), ("page-size", str(PAGE_SIZE))]
       params.extend([("section", s) for s in SECTIONS])
   
       # Encode parameters
       query_string = "&".join([f"{k}={v}" for k, v in params])
       full_url = f"{url}?{query_string}"
   
       headers = {
           "Authorization": f"Bearer {token}",
           "Accept": "application/json"
       }
   
       response = http.request(
           'GET',
           full_url,
           headers=headers,
           timeout=60.0
       )
   
       if response.status != 200:
           raise Exception(f"Failed to fetch page {page}: {response.status} {response.data.decode('utf-8')}")
   
       return json.loads(response.data.decode('utf-8'))
   
   def write_ndjson_gz(objs, when):
       buf = io.BytesIO()
       with gzip.GzipFile(filename="-", mode="wb", fileobj=buf, mtime=int(time.time())) as gz:
           for obj in objs:
               line = json.dumps(obj, separators=(",", ":")) + "\n"
               gz.write(line.encode("utf-8"))
   
       buf.seek(0)
   
       prefix = GCS_PREFIX.strip("/") + "/" if GCS_PREFIX else ""
       key = f"{prefix}{when:%Y/%m/%d}/jamf_pro_context_{int(when.timestamp())}.ndjson.gz"
   
       bucket = storage_client.bucket(GCS_BUCKET)
       blob = bucket.blob(key)
       blob.upload_from_file(buf, content_type="application/gzip")
   
       return key
   
   @functions_framework.cloud_event
   def main(cloud_event):
       """
       Cloud Run function triggered by Pub/Sub to fetch Jamf Pro context logs and write to Cloud Storage.
   
       Each computer is written exactly as Jamf returns it: the inventory sections
       (general, hardware, operatingSystem, userAndLocation, and so on) are top-level
       keys on the record. The default parser reads this shape directly, so the records
       are not reshaped here.
   
       Args:
           cloud_event: CloudEvent object containing Pub/Sub message
       """
   
       if not all([BASE_URL, CLIENT_ID, CLIENT_SECRET, GCS_BUCKET]):
           print("Error: Missing required environment variables")
           return
   
       try:
           page = 0
           total = 0
           batch = []
           now = datetime.now(timezone.utc)
   
           while True:
               payload = fetch_page(get_valid_token(), page)
               results = payload.get("results") or []
   
               if not results:
                   break
   
               # Write the Jamf records as returned; do not rename or nest fields.
               batch.extend(results)
               total += len(results)
   
               if len(batch) >= 5000:
                   key = write_ndjson_gz(batch, now)
                   print(f"Wrote {len(batch)} records to gs://{GCS_BUCKET}/{key}")
                   batch = []
   
               if len(results) < PAGE_SIZE:
                   break
   
               page += 1
   
           if batch:
               key = write_ndjson_gz(batch, now)
               print(f"Wrote {len(batch)} records to gs://{GCS_BUCKET}/{key}")
   
           print(f"Successfully processed {total} total records")
   
       except Exception as e:
           print(f"Error processing Jamf Pro context logs: {str(e)}")
           raise
   

   注意：此脚本仅作为示例提供，不受官方支持。欢迎您提供反馈，告诉我们如何改进该功能。如需提交反馈，请点击本页面上的发送反馈 > Google SecOps 安全产品反馈。
   • 第二个文件：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. 在控制台中，前往 Cloud Scheduler。
2. 点击创建作业。

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

   设置	值
   名称	jamfpro-context-schedule-1h
   区域	选择与 Cloud Run 函数相同的区域
   频率	0 * * * *（每小时一次，整点时）
   时区	选择时区（建议选择 UTC）
   目标类型	Pub/Sub
   主题	选择 Pub/Sub 主题 (jamf-pro-context-trigger)
   消息正文	{}（空 JSON 对象）

4. 点击创建。

测试调度器作业

1. 在 Cloud Scheduler 控制台中，找到您的作业。
2. 点击强制运行以手动触发。
3. 等待几秒钟，然后前往 Cloud Run > 服务 > jamf-pro-context-collector > 日志。
4. 验证函数是否已成功执行。
5. 检查 Cloud Storage 存储桶，确认日志是否已写入。

在 Google SecOps 中配置 Feed 以注入 Jamf Pro 上下文日志

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

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

   chronicle-12345678@chronicle-gcp-prod.
   

8. 复制此电子邮件地址。您将在下一步骤中用到它。

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

9. 点击下一步。

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

11. 存储桶网址：输入带有前缀路径的 Cloud Storage 存储桶 URI：

    gs://jamfpro/jamf-pro/context/
    

    将 jamfpro 替换为存储桶的实际名称。

    注意： 请务必在 URI 末尾添加尾随斜杠 (/)。

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

  • 永不：转移后永不删除任何文件（建议用于测试）。
  • 删除已转移的文件：在成功转移后删除文件。
  • 删除已转移的文件和空目录：成功转移后删除文件和空目录。
  注意： 如果您选择删除选项，服务账号必须具有 Storage Object Admin 角色，而不是 Storage Object Viewer 角色。相应地更新 IAM 权限。

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

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

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

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

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

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

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

8. 点击保存。

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

更新日志

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

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